Skip to content

Fix positional arguments section: click.Argument do not lose their help + deprecation labels - #223

Merged
janluke merged 1 commit into
masterfrom
fix/click-argument-help
Sep 10, 2026
Merged

Fix positional arguments section: click.Argument do not lose their help + deprecation labels#223
janluke merged 1 commit into
masterfrom
fix/click-argument-help

Conversation

@janluke

@janluke janluke commented Sep 9, 2026

Copy link
Copy Markdown
Owner

Fixes #210.

Regarding this comment:

There's another difference between Click and Cloup. Both print a "Positional arguments" section if at least 1 argument has help but:

  • Cloup includes all arguments in the section, including those with no help

  • Click only includes arguments with a help.

I guess the reasoning was that the arguments are already listed in the usage anyway, but I think this is potentially misleading for users.

I decided to keep Cloup behavior.

@janluke janluke added the bug Something isn't working label Sep 9, 2026
@janluke
janluke force-pushed the fix/click-argument-help branch from 44aa107 to f3c27fb Compare September 9, 2026 02:53
@codecov

codecov Bot commented Sep 9, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 97.14286% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 96.75%. Comparing base (fa4db00) to head (1af1b33).

Files with missing lines Patch % Lines
src/cloup/_params.py 96.55% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #223      +/-   ##
==========================================
+ Coverage   96.71%   96.75%   +0.04%     
==========================================
  Files          22       22              
  Lines        1551     1573      +22     
==========================================
+ Hits         1500     1522      +22     
  Misses         51       51              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@janluke
janluke force-pushed the fix/click-argument-help branch from f3c27fb to 3190739 Compare September 9, 2026 02:59
…uments support `deprecated` of type string

Fixes #210.
@janluke
janluke force-pushed the fix/click-argument-help branch 2 times, most recently from 9a70057 to 1af1b33 Compare September 10, 2026 02:42
@janluke
janluke merged commit 2620040 into master Sep 10, 2026
17 checks passed
@janluke
janluke deleted the fix/click-argument-help branch September 10, 2026 02:45
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.

cloup.Argument and click.Argument diverge now that Click 8.5.0 has argument help

1 participant