Skip to content

Conversation

@cnaples79
Copy link

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
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.

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