Remove weird looking dashes#76849
Closed
AMythicDev wants to merge 2 commits intorust-lang:masterfrom
AMythicDev:master
Closed
Remove weird looking dashes#76849AMythicDev wants to merge 2 commits intorust-lang:masterfrom AMythicDev:master
AMythicDev wants to merge 2 commits intorust-lang:masterfrom
AMythicDev:master
Conversation
Contributor
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
Member
|
I guess it was for "platform-specific" and "feature-specific", but it looked weird. Maybe an english native might have another idea on how to make it look less weird? cc @rust-lang/docs |
Contributor
|
"Documenting platform- or feature-specific information" reads well to me. |
Contributor
|
You could also just not refactor |
jyn514
added
A-docs
Member
|
only tangentially related, but this entire section needs to be rewritten after #73566. |
Member
|
It should probably be removed from |
Member
I'll work on this. |
Member
|
Opened #76855 |
Contributor
Author
|
I changed the line for a longer heading |
Contributor
Author
|
So let's rollup the PR |
Member
jyn514
added a commit
to jyn514/rust
that referenced
this pull request
Oct 5, 2020
- Move `cfg(doc)` out of `unstable-features`. It's not unstable. - Remove outdated reference to `everybody_loops`. - Improve wording in various places - Give an example of code this allows (and does not allow) - Link to `cfg(doc)` in `doc(cfg)` documentation. Since one is stable and the other is not, don't combine them. - Cleanup wording for `doc(cfg)` - Incorporate changes from rust-lang#76849 - Mention that `doc(cfg)` is also for features
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this pull request
Oct 6, 2020
Revamp rustdoc docs about documentation using `cfg` - Move `cfg(doc)` out of `unstable-features`. It's not unstable. - Remove outdated reference to `everybody_loops`. - Improve wording in various places - Give an example of code this allows (and does not allow) - Link to `cfg(doc)` in `doc(cfg)` documentation. Since one is stable and the other is not, don't combine them. - Cleanup wording for `doc(cfg)` - Incorporate changes from rust-lang#76849 - Mention that `doc(cfg)` is also for features Addresses rust-lang#76849 (comment). Obsoletes rust-lang#76849 (I made sure to fix the weird dashes too). r? @steveklabnik
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Removed some weird looking dashes from the unstable book. It could look like to a newcomer that someone had made a typo while writing the docs