runtime: fix stability feature flags for docs #6909
Conversation
github-actions
bot
added
R-loom-current-thread
There was a problem hiding this comment.
As a sidenote, I wonder if it would be possible to use https://doc.rust-lang.org/rustdoc/unstable-features.html#doc_auto_cfg-automatically-generate-doccfg instead of manually adding all these attributes? Are there places where you would not want the specified items to be documented with their required feature flags? I did see a couple of places where there's a different implementation depending on which flag is in use, perhaps that's the problem here?
Darksonn
added
T-docs
tokio/src/runtime/builder.rs
Outdated
| @@ -728,6 +728,7 @@ impl Builder { | |||
| /// # } | |||
| /// ``` | |||
| #[cfg(all(not(loom), tokio_unstable))] | |||
| #[cfg_attr(docsrs, doc(cfg(all(not(loom), tokio_unstable))))] | |||
There was a problem hiding this comment.
Loom should not be mentioned in docs.
| #[cfg_attr(docsrs, doc(cfg(all(not(loom), tokio_unstable))))] | |
| #[cfg_attr(docsrs, doc(cfg(tokio_unstable)))] |
There was a problem hiding this comment.
Please fix all instances of this issue. Marking unresolved.
Co-authored-by: Alice Ryhl <aliceryhl@google.com>
| #[cfg(all(not(loom), tokio_unstable))] | ||
| #[cfg_attr(docsrs, doc(cfg(tokio_unstable)))] | ||
| pub fn on_task_spawn<F>(&mut self, f: F) -> &mut Self |
There was a problem hiding this comment.
Please also add the docs blurb about this being unstable.
/// **Note**: This is an [unstable API][unstable]. The public API of this type
/// may break in 1.x releases. See [the documentation on unstable
/// features][unstable] for details.
///
/// [unstable]: crate#unstable-featuresI would add it to on_task_spawn, on_task_terminate, and TaskMeta. Probably not to MultiThreadAlt.
Motivation
Fixes: #6907
Solution
Adds doc attribute noting the tokio_unstable requirements for various items