Add backticks around paths for GetSystemWindowsDirectory documentation#2207
Open
Chris-Johnston wants to merge 2 commits into
Open
Add backticks around paths for GetSystemWindowsDirectory documentation#2207Chris-Johnston wants to merge 2 commits into
Chris-Johnston wants to merge 2 commits into
Conversation
The path at the end of the sentence (`C:\.`) was being rendered as `C:.`, which was confusing because the sentence itself was discussing the semantics of when the provided path would end with a backslash. Markdown was using the backslash to escape the `.` (which is used for unordered lists), instead of rendering the backslash. This could also be fixed with `C:\\`, but I think wrapping this in code brackets also makes it clear that `.` is not part of the path.
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
1 participant
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.
In the documentation for
lpBufferinGetSystemWindowsDirectory, it calls out that if Windows is in the root directory of the drive, the returned path should end with a backslash. However, as it is rendered on the site, this doesn't have a backslash, which is confusing:This is because markdown is escaping the period character, since that is used for unordered lists. I could have just done
C:\\to escape the backslash, but I think the inline code backticks also make it clear that "." is not part of the path either.This is not going to be the only instance of this problem in the docs, but it uniquely affected this sentence. This query for instances of
C:\and notC:\\might help find other cases that would need a similar fix, it only matters if the character after\can be escaped in Markdown.