about summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Tolnay <dtolnay@gmail.com>2024-04-05 18:54:38 -0700
committerDavid Tolnay <dtolnay@gmail.com>2024-04-05 18:54:38 -0700
commit262670a8f105803c28ba50014644ddbc6fa9accf (patch)
tree15911e25f66bbb345e64d2a0c8fc2ed06e992236
parent11853ecd86c10dcc8b10d2bbf737fbf9bffe27bc (diff)
downloadrust-262670a8f105803c28ba50014644ddbc6fa9accf.tar.gz
rust-262670a8f105803c28ba50014644ddbc6fa9accf.zip
Hide async_gen_internals from standard library documentation
-rw-r--r--library/core/src/async_iter/async_iter.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/library/core/src/async_iter/async_iter.rs b/library/core/src/async_iter/async_iter.rs
index 489f95bbf10..a0ffb6d4750 100644
--- a/library/core/src/async_iter/async_iter.rs
+++ b/library/core/src/async_iter/async_iter.rs
@@ -116,6 +116,7 @@ where
 impl<T> Poll<Option<T>> {
     /// A helper function for internal desugaring -- produces `Ready(Some(t))`,
     /// which corresponds to the async iterator yielding a value.
+    #[doc(hidden)]
     #[unstable(feature = "async_gen_internals", issue = "none")]
     #[lang = "AsyncGenReady"]
     pub fn async_gen_ready(t: T) -> Self {
@@ -124,6 +125,7 @@ impl<T> Poll<Option<T>> {
 
     /// A helper constant for internal desugaring -- produces `Pending`,
     /// which corresponds to the async iterator pending on an `.await`.
+    #[doc(hidden)]
     #[unstable(feature = "async_gen_internals", issue = "none")]
     #[lang = "AsyncGenPending"]
     // FIXME(gen_blocks): This probably could be deduplicated.
@@ -131,6 +133,7 @@ impl<T> Poll<Option<T>> {
 
     /// A helper constant for internal desugaring -- produces `Ready(None)`,
     /// which corresponds to the async iterator finishing its iteration.
+    #[doc(hidden)]
     #[unstable(feature = "async_gen_internals", issue = "none")]
     #[lang = "AsyncGenFinished"]
     pub const FINISHED: Self = Poll::Ready(None);