Move inline code snippets to code blocks #8462
Merged
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
0xc0170
approved these changes
Oct 17, 2018
cmonr
reviewed
Oct 17, 2018
platform/DirHandle.h
Outdated
| * DIR *d = opendir("/example"); | ||
| * @endcode | ||
| * to open the root of the filesystem and then using readdir, | ||
| * closedir, etc with the directory pointer. |
There was a problem hiding this comment.
Duno why, but this sentence feels like a both a run-on sentence, and like it's worded weirdly.
There was a problem hiding this comment.
Yeah sort of choppily rewrote that segment, one second.
There was a problem hiding this comment.
Is this referring to the FileSystem class or any file system? If the latter, we should make it two words.
|
Removing from rollup due to merge check uncertainty. |
Add "s" for agreement.
kegilbert
force-pushed
the
kegilbert-patch-6-1
branch
from
da5b09e to
7d604fe
Compare
Edit for active voice.
AnotherButler
approved these changes
Oct 18, 2018
cmonr
approved these changes
Oct 18, 2018
cmonr
added
needs: CI
release-version: 5.10.2
rollup PR
and removed
needs: review
labels
Merged
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.
Description
Moving this small code snippet into a code block allows the doxy spell checker to work better (the extra asterisks and function calls were causing issues). It does however make the raw header look a bit uglier.
Thoughts (new generated doxy below)?
Pull request type