Use code formatting for code-relevant values in std::fmt docs #28723
Conversation
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
Especially when documenting the use of `0`, since zero looks very similar to `O` in fonts not meant for displaying code. Other literal characters, traits, etc should also use code formatting. This change makes this documentation more internally consistent.
|
(rust_highfive has picked a reviewer for you, use r? to override) |
|
👍 thanks! |
|
@bors: r+ rollup |
|
📌 Commit a33d61a has been approved by |
bors
added a commit
that referenced
this pull request
Sep 29, 2015
Especially when documenting the use of `0`, since zero looks very similar to `O` in fonts not meant for displaying code. Other literal characters, traits, etc should also use code formatting. This change makes this documentation more internally consistent. Before this change, circled is the character I was using this documentation to find out about and that confused me when it wasn't immediately clear what character it was: <img width="1013" alt="screen shot 2015-09-28 at 10 13 31 pm" src="https://cloud.githubusercontent.com/assets/193874/10154708/c70815fe-6638-11e5-9acc-57c73a524203.png"> After this change: <img width="981" alt="screen shot 2015-09-28 at 11 26 35 pm" src="https://cloud.githubusercontent.com/assets/193874/10154710/ce73eeb2-6638-11e5-98f7-902f58679316.png"> I ran `make check-docs` and didn't break anything ⭐
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Especially when documenting the use of
0, since zero looks verysimilar to
Oin fonts not meant for displaying code.Other literal characters, traits, etc should also use code formatting.
This change makes this documentation more internally consistent.
Before this change, circled is the character I was using this documentation to find out about and that confused me when it wasn't immediately clear what character it was:
After this change:
I ran
make check-docsand didn't break anything ⭐