Reorder the command line options in the manual #2766
Merged
+358
−336
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
itchyny
force-pushed
the
sort-manual-command-options
branch
from
c96ae26
to
f87414d
Compare
| @@ -104,74 +104,58 @@ sections: | |||
| You can affect how jq reads and writes its input and output | |||
| using some command-line options: | |||
|
|
|||
| * `--version`/`-V`: | |||
There was a problem hiding this comment.
You don't think --version should be first?
There was a problem hiding this comment.
I think the option (at least the long option) is obvious and don't think it should be first.
|
LGTM! |
|
Thanks. |
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.
I have always thought the order of command line options in the manual is very unfriendly. It lists
--seqand--streamat the top, but they are used less often than--null-inputand--compact-output. In #2747, I ordered the list carefully to make it easy to understand, and in this PR, I reordered the manual to match the output of--help. Roughly in the order of input options, output options, advanced input/output options (--stream,--seq), module options, arg options, and other options.