Update docs to mention L and C chars suffixes with pathnames - #496
Merged
Merged
Conversation
rswgnu
approved these changes
Mar 28, 2024
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
2 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.
What
Update docs to mention L and C chars.
Why
The pathname docs focuses on only number line and column in
pathnames. But the line and column suffixes also support the L and C
char receptively. That style is also used in the generated links. So
we need to explain this better.
Note
Was trickier than expected since line:col is used in many places and
adding optional L and C there would be verbose. So adopting the style
that pure line:col can mean with or without the characters. So just
hinting in the docstring that they are possible. In a few places they
are mention when we talk about what pattern is supported.