Always list all positional arguments - #3860
Open
kdeldycke wants to merge 2 commits into
Open
Conversation
kdeldycke
added
the
help output
Cloup already renders the section this way: janluke/cloup#210
kdeldycke
force-pushed
the
list-all-positional-arguments
branch
from
September 9, 2026 09:32
67ed980 to
28c7ae0
Compare
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.
This is inconsistent with the way options are displayed, as every options are displayed including those without help.
The reason to display all arguments in the
Positional argumentssection is to not introduce subtle confusion, as an argument without help would only be noticeable in the usage line.Cloup already renders the section this way (see janluke/cloup#210) and is the source discussion with @janluke for that bug fix.
In this implementation, I refrained to always display the
Positional argumentssection. So I made the decision to not print thePositional argumentssection in full if and only if at least one of its argument has anhelp. This decision is open to discussion.This is a follow up on #3473