Skip to content

Commit b48726f

Browse files
committed
doc: clarify where to get a ConstToken
1 parent 2ddeac7 commit b48726f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/const_api.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ use core::marker::PhantomData;
55
///
66
/// Some `const fn`s in this crate will need an instance of this type
77
/// for some type-level information usually provided by traits.
8+
///
9+
/// A token can be obtained from [`BitFlags::CONST_TOKEN`]. The relevant types
10+
/// should be readily inferred from context.
11+
///
812
/// For an example of usage, see [`not_c`][BitFlags::not_c].
913
pub struct ConstToken<T, N>(BitFlags<T, N>);
1014

0 commit comments

Comments
 (0)