-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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
Update documentation for doc_cfg feature #92818
Conversation
(rust-highfive has picked a reviewer for you, use r? to override) |
r? @camelid |
This comment has been minimized.
This comment has been minimized.
b2b08fd
to
2ad4a66
Compare
Updated! |
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.
Just a couple more comments.
@@ -84,6 +84,37 @@ in documentation. | |||
`#![feature(doc_cfg)]` feature gate. For more information, see [its chapter in the Unstable | |||
Book][unstable-doc-cfg] and [its tracking issue][issue-doc-cfg]. | |||
|
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.
I think we should maybe put doc_auto_cfg
in its own section (perhaps called #![feature(doc_auto_cfg)]
or something like that). It's kind of a freestanding feature—i.e., you can use it without using doc_cfg
.
Make sure to change "An extension to this feature" to "An extension to doc_cfg
".
It'll render almost the same, the difference being that `doc` will also be displayed. To fix this, | ||
you can use `doc_cfg_hide`: |
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.
Not a comment about the docs, but shouldn't hiding doc
be the default behavior?
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.
Once #92856 is merged, it'll be pretty easy to ignore it as well.
2ad4a66
to
110aedd
Compare
@camelid Done! |
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.
One last change, and then r=me
110aedd
to
241d977
Compare
@bors: r=camelid rollup |
📌 Commit 241d977 has been approved by |
…r=camelid Update documentation for doc_cfg feature Fixes rust-lang#92484.
…r=camelid Update documentation for doc_cfg feature Fixes rust-lang#92484.
…askrgr Rollup of 9 pull requests Successful merges: - rust-lang#92045 (Don't fall back to crate-level opaque type definitions.) - rust-lang#92381 (Suggest `return`ing tail expressions in async functions) - rust-lang#92768 (Partially stabilize `maybe_uninit_extra`) - rust-lang#92810 (Deduplicate box deref and regular deref suggestions) - rust-lang#92818 (Update documentation for doc_cfg feature) - rust-lang#92840 (Fix some lints documentation) - rust-lang#92849 (Clippyup) - rust-lang#92854 (Use the updated Rust logo in rustdoc) - rust-lang#92864 (Fix a missing dot in the main item heading) Failed merges: - rust-lang#92838 (Clean up some links in RELEASES) r? `@ghost` `@rustbot` modify labels: rollup
Fixes #92484.