Skip to content

🐛 fix(metavar): render all tuple metavar elements and suppress None defaults#287

Merged
gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat:fix-tuple-metavar
Mar 2, 2026
Merged

🐛 fix(metavar): render all tuple metavar elements and suppress None defaults#287
gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat:fix-tuple-metavar

Conversation

@gaborbernat
Copy link
Member

Tuple metavars (e.g. nargs=2 with metavar=("KEY", "VALUE")) only rendered the first element, making the documentation misleading for multi-value arguments. Now all elements are joined with spaces so the full signature is visible.

Additionally, arguments with default=None no longer display (default: "None") in the output. The string "None" added no useful information and was confusing — users couldn't tell if None was a real default or just Python's representation of no default.

Fixes #159, fixes #177

@gaborbernat gaborbernat added the bug Something isn't working label Mar 2, 2026
@gaborbernat gaborbernat closed this Mar 2, 2026
@gaborbernat gaborbernat reopened this Mar 2, 2026
…efaults

Tuple metavars (e.g. nargs=2 with metavar=("KEY", "VALUE")) only rendered
the first element. Now all elements are joined with spaces. Additionally,
arguments with default=None no longer display "(default: None)" since that
adds no useful information.

Fixes tox-dev#159, fixes tox-dev#177
@gaborbernat gaborbernat merged commit c0d59e0 into tox-dev:main Mar 2, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug: tuple metavar not correctly displayed optional arguments with nargs issues

1 participant