Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add API to control whether synopsis should be sorted or not #1574

Closed
remkop opened this issue Feb 14, 2022 · 0 comments
Closed

Add API to control whether synopsis should be sorted or not #1574

remkop opened this issue Feb 14, 2022 · 0 comments
Labels
theme: arg-group An issue or change related to argument groups theme: usagehelp An issue or change related to the usage help message type: API 🔌
Milestone
4.7

Comments

@remkop
Copy link
Owner

remkop commented Feb 14, 2022

Related to #964 and #1408: instead of sorting the synopsis based on the @Command(sortOptions = false) annotation, it may be better to have a separate @Command(sortSynopsis = false) annotation.

There may be applications that want to explicitly sort options in the options list, but have the synopsis sorted alphabetically.
Also, having a separate API to enable the changes in #964 and #1408 avoids the risk of somehow breaking existing applications that expect the synopsis to look a certain way.
@remkop remkop added type: API 🔌 theme: arg-group An issue or change related to argument groups theme: usagehelp An issue or change related to the usage help message labels Feb 14, 2022
@remkop remkop added this to the 4.7 milestone Feb 14, 2022
remkop added a commit that referenced this issue Feb 14, 2022
@remkop
[#1408] (WIP pending #1574) synopsis should respect order (if specified)
2ba9f62
@remkop remkop closed this as completed in 84fa2c2 Feb 14, 2022
remkop added a commit that referenced this issue Feb 14, 2022
@remkop
[#1574] DOC update RELEASE-NOTES and user manual
44a1453
@remkop remkop mentioned this issue Feb 14, 2022
Closed
remkop added a commit that referenced this issue Feb 15, 2022
@remkop
[#1574][#1408][#964] add tests
50a8df2
remkop added a commit that referenced this issue Feb 15, 2022
@remkop
[#1574][#1408] DOC: improve user manual and javadoc
ae3136d
@remkop remkop mentioned this issue Feb 15, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
theme: arg-group An issue or change related to argument groups theme: usagehelp An issue or change related to the usage help message type: API 🔌
Projects
None yet
Milestone
4.7
Development

No branches or pull requests
1 participant
@remkop