Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update documentation for doc_cfg feature #92818

Merged
merged 1 commit into from
Jan 14, 2022
Merged

Update documentation for doc_cfg feature #92818

merged 1 commit into from
Jan 14, 2022

Conversation

GuillaumeGomez
Copy link
Member

Fixes #92484.

@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jan 12, 2022
@rust-highfive
Copy link
Collaborator

r? @steveklabnik

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 12, 2022
@GuillaumeGomez GuillaumeGomez changed the title Update documentation for doc_cfg Update documentation for doc_cfg feature Jan 12, 2022
@GuillaumeGomez
Copy link
Member Author

r? @camelid

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
Copy link
Member Author

Updated!

@GuillaumeGomez GuillaumeGomez mentioned this pull request Jan 13, 2022
Open
5 tasks
camelid
camelid reviewed Jan 13, 2022
View reviewed changes
Copy link
Member

@camelid camelid left a 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.

src/doc/rustdoc/src/unstable-features.md
@@ -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].

Copy link
Member

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".

src/doc/rustdoc/src/unstable-features.md
Comment on lines +108 to +111
It'll render almost the same, the difference being that `doc` will also be displayed. To fix this,
you can use `doc_cfg_hide`:
Copy link
Member

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?

Copy link
Member Author

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.

@camelid camelid added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 13, 2022
@GuillaumeGomez
Copy link
Member Author

@camelid Done!

camelid
camelid approved these changes Jan 13, 2022
View reviewed changes
Copy link
Member

@camelid camelid left a 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

src/doc/rustdoc/src/unstable-features.md Outdated Show resolved Hide resolved
@GuillaumeGomez
Copy link
Member Author

@bors: r=camelid rollup

@bors
Copy link
Contributor

bors commented Jan 13, 2022

📌 Commit 241d977 has been approved by camelid

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 13, 2022
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jan 14, 2022
@matthiaskrgr
Rollup merge of rust-lang#92818 - GuillaumeGomez:update-doc-cfg-doc, …
826b2b2 
…r=camelid

Update documentation for doc_cfg feature

Fixes  rust-lang#92484.
@matthiaskrgr matthiaskrgr mentioned this pull request Jan 14, 2022
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jan 14, 2022
@matthiaskrgr
Rollup merge of rust-lang#92818 - GuillaumeGomez:update-doc-cfg-doc, …
276dcf4 
…r=camelid

Update documentation for doc_cfg feature

Fixes  rust-lang#92484.
This was referenced Jan 14, 2022
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 14, 2022
@bors
Auto merge of rust-lang#92883 - matthiaskrgr:rollup-uoudywx, r=matthi…
ad46af2 
…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
@bors bors merged commit 3cbc448 into rust-lang:master Jan 14, 2022
@rustbot rustbot added this to the 1.60.0 milestone Jan 14, 2022
@GuillaumeGomez GuillaumeGomez deleted the update-doc-cfg-doc branch January 14, 2022 20:35
@GuillaumeGomez GuillaumeGomez mentioned this pull request Oct 1, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@taiki-e taiki-e taiki-e left review comments

@camelid camelid camelid approved these changes

Assignees

@camelid camelid

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.60.0
Development

Successfully merging this pull request may close these issues.

Missing documentation for rustdoc features doc_cfg_hide and doc_auto_cfg
8 participants
@GuillaumeGomez @rust-highfive @rust-log-analyzer @bors @camelid @taiki-e @steveklabnik @rustbot