Skip to content

docs: clarify required argument behavior in arguments guide#3246

Closed
mitre88 wants to merge 1 commit intopallets:mainfrom
mitre88:codex/issue-3175-arguments-doc-clarity
Closed

docs: clarify required argument behavior in arguments guide#3246
mitre88 wants to merge 1 commit intopallets:mainfrom
mitre88:codex/issue-3175-arguments-doc-clarity

Conversation

@mitre88
Copy link

@mitre88 mitre88 commented Mar 5, 2026

Summary

  • updates docs/arguments.rst to improve clarity and grammar
  • aligns the “required arguments” note with the actual click.Argument behavior in src/click/core.py
  • keeps scope to a single file, as requested in Improve documentation #3175

What changed

  • clarified that arguments are required by default when nargs > 0 and no default is set
  • documented how to make arguments optional (default or required=False)
  • improved wording in a few related sections for readability and consistency

fixes #3175

@davidism davidism closed this Mar 5, 2026
@davidism
Copy link
Member

davidism commented Mar 5, 2026

Appears LLM generated. Removes important context.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation

2 participants