-
-
Notifications
You must be signed in to change notification settings - Fork 433
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
document more crate features #1411
Conversation
It's better to switch to the |
I looked into that but the difference between the two doesn't seem well documented and it didn't seem to do anything that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On a final note, do you want to fix #1327 here? The comment in Cargo.toml
should probably use this command:
RUSTDOCFLAGS="--cfg doc_cfg -Zunstable-options --generate-link-to-definition" cargo +nightly doc --all --all-features --no-deps --open
#[cfg(feature = "alloc")] | ||
#[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))] | ||
impl<'a, S: Index<usize, Output = T> + ?Sized + 'a, T: 'a> Iterator for SliceChooseIter<'a, S, T> { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't show up anywhere because SliceChooseIter
is already cfg(feature = "alloc")
and Iterator
is not a local trait.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it worth leaving it here in case rustdoc picks it up later?
I'll add that to the toml sure |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Don't care much about the redundant docs. Thanks!
This should hopefully avoid issues like #1410. I tried getting
doc_cfg
to work again but didn't have much luck so I defaulted to doc comments