Skip to content

Commit 262670a

Browse files
committed
Hide async_gen_internals from standard library documentation
1 parent 11853ec commit 262670a

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

library/core/src/async_iter/async_iter.rs

+3
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ where
116116
impl<T> Poll<Option<T>> {
117117
/// A helper function for internal desugaring -- produces `Ready(Some(t))`,
118118
/// which corresponds to the async iterator yielding a value.
119+
#[doc(hidden)]
119120
#[unstable(feature = "async_gen_internals", issue = "none")]
120121
#[lang = "AsyncGenReady"]
121122
pub fn async_gen_ready(t: T) -> Self {
@@ -124,13 +125,15 @@ impl<T> Poll<Option<T>> {
124125

125126
/// A helper constant for internal desugaring -- produces `Pending`,
126127
/// which corresponds to the async iterator pending on an `.await`.
128+
#[doc(hidden)]
127129
#[unstable(feature = "async_gen_internals", issue = "none")]
128130
#[lang = "AsyncGenPending"]
129131
// FIXME(gen_blocks): This probably could be deduplicated.
130132
pub const PENDING: Self = Poll::Pending;
131133

132134
/// A helper constant for internal desugaring -- produces `Ready(None)`,
133135
/// which corresponds to the async iterator finishing its iteration.
136+
#[doc(hidden)]
134137
#[unstable(feature = "async_gen_internals", issue = "none")]
135138
#[lang = "AsyncGenFinished"]
136139
pub const FINISHED: Self = Poll::Ready(None);

0 commit comments

Comments
 (0)