Conversation
ezeprimo
force-pushed
the
fix/help-synopsis-brackets-949
branch
from
September 21, 2026 23:52
ceaee79 to
7d08b68
Compare
Contributor
|
Thank you for the PR. I don't see how it is related to #949 . But it actually fixes a valid inconsistency, I created an issue for it: #1389. Please rebase this PR on the latest |
fmbenhassine
added
the
status/need-feedback
Required options were rendered as [--opt Type] and optional ones as bare text, opposite to Unix convention. Render required options bare and optional ones bracketed in CommandHelpRenderer, where help rendering now lives. Fixes spring-projects#1389 Signed-off-by: ezequiel primon <ezeprimo.ia@gmail.com>
ezeprimo
force-pushed
the
fix/help-synopsis-brackets-949
branch
from
September 24, 2026 21:08
7d08b68 to
694f3e7
Compare
Contributor
Author
|
Done. Rebased and moved the fix to CommandHelpRenderer. It now closes #1389. Ready for another look when you have a moment. |
Contributor
|
LGTM now 👍 Rebased and merged as 8277c60. Thank you for your contribution! |
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.
Fixes #1389
Required options were rendered as
[--opt Type]and optional ones as bare text, opposite to Unix convention and to the arguments logic in the same file. This made required options look optional in the help.Note: this PR was originally opened against #949; per maintainer feedback it is unrelated to that issue (see #1389). It has been rebased on latest
main, moving the fix fromHelptoCommandHelpRenderer, where help rendering now lives.Summary:
--opt Type) and optional ones bracketed ([--opt Type]) in SYNOPSISspring-shell-core/.../command/CommandHelpRenderer.javaspring-shell-core/.../command/CommandHelpRendererTests.javaspring-shell-core/.../command/HelpTests.javaTest plan:
mvn -pl spring-shell-core -am -Dtest=CommandHelpRendererTests,HelpTests test: 16/16 green (JDK 17)mvn -pl spring-shell-core -am test: 281/281 green