Style: Misc docs and comment style and language fixes #68120
Merged
Conversation
This file contains 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
akien-mga
force-pushed
the
style-doc-cleanup
branch
from
c0bafc5 to
736917b
Compare
bruvzg
reviewed
Nov 1, 2022
mhilbrunner
reviewed
Nov 1, 2022
mhilbrunner
approved these changes
Nov 1, 2022
Fine by me. |
aaronfranke
approved these changes
Nov 1, 2022
- Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
akien-mga
force-pushed
the
style-doc-cleanup
branch
from
736917b to
f7c611a
Compare
4 tasks
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.
[code]when hyperlinks could be used ([member],[constant]).@GlobalScopeforenumandconstant.method, which makes sense to me. In this PR I just changedenumandconstantbecause the predominant usage is without@GlobalScope, e.g.[enum Error]and[constant OK].