Documentation updates (path operand, &c.) #728
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
Fixes BurntSushi#725 (sort of) * Capitalise place-holder names consistently * Document PATTERN and PATH * Add note about PATH overriding glob/ignore rules
Fixes BurntSushi#725 (sort of) * Capitalise place-holder names consistently * Add note about PATH overriding glob/ignore rules
|
RE ci failures: My bet is on the capitalization of |
|
lol, oops. Should have done a more thorough test than just Pushed a fix, it seems better now. |
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.
Fixes #725 (i guess?)
I capitalised the place-holders
optionsandpathto make them consistent withPATTERN&al.I added documentation of the positional arguments to the man page
I added a note to both the man page and the usage help to clarify that an explicit
PATHoverrides glob/ignore rules. This could possibly be clearer i guess — a glob/ignore rule is only overridden if the path as given on the command line contains a segment that actually matches it — but it didn't seem worth writing a whole paragraph aboutI'm not sure when this became an issue, but when i regenerated the man page all of the long option names were broken — Pandoc had converted
--foointo–foo(with an en dash). I updatedconvert-to-manto disable 'smart typography', which seems to have fixed it for Pandoc 2.0.6; hopefully it doesn't cause issues for contributors on older versions