doc: Don't sort subcommands in "See Also" section #2346
+4
−24
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
The cmd.Commands() slice is ordered for a reason, it allows developers to choose the order in which subcommands are shown in the usage message. Let's also keep that order when listing subcommands in the See Also section.
Contributor
|
I would prefer an option to do not sort them. I feel like many people maybe surprised for things no longer being ordered |
Author
|
The commands are not sorted in the default usage function and default usage template, so why sort them by default in the generated docs? That seems unnecessarily inconsistent. |
Author
Actually, the subcommands returned by I edited the PR description to reflect that. |
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.
The subcommands in the
Command.Commands()slice are sorted alphabetically by default. That can be disabled by settingcobra.EnableCommandSorting = falsein which case the order in which subcommands are added viaCommand.AddCommandis retained. That order is used in the "Available Commands:" section in the usage message. Let's also keep that order when listing subcommands in the "See Also" section of generated docs.