Skip to content

Clarify option decorator argument wording#3191

Closed
cnaples79 wants to merge 1 commit intopallets:mainfrom
cnaples79:docs-improve-3175
Closed

Clarify option decorator argument wording#3191
cnaples79 wants to merge 1 commit intopallets:mainfrom
cnaples79:docs-improve-3175

Conversation

@cnaples79
Copy link
Copy Markdown

Summary

  • clarify that option decorators accept one or more option names and can optionally specify the function argument name
  • explain the common inference pattern for dashed option names mapping to underscored parameter names
  • rewrite the basic example description to state the default optional behavior and type

Rationale

Changes

  • update docs/options.md with clearer language around argument inference and default option behavior

Tests

  • not run (docs-only change)

Fixes #3175

@davidism
Copy link
Copy Markdown
Member

Did you use an LLM tool to make this?

I can kinda see what was attempted here, but if you're saying the original was confusing, this doesn't seem any better, just different. It still feels out of order and doesn't really match the code.

@kdeldycke
Copy link
Copy Markdown
Collaborator

It is safe to consider this PR as superseded by #3192, which has just been merged upstream. Unless the original author is rebasing the changes on top of the new option documentation.

@kdeldycke kdeldycke added this to the 8.3.2 milestone Mar 15, 2026
@kdeldycke kdeldycke added the docs label Mar 15, 2026
@davidism davidism closed this Mar 15, 2026
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Mar 30, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation

3 participants