Skip to content

docs: clarify usage of option with multiple values#1517

Closed
ananya4khandelwal wants to merge 2 commits intofastapi:masterfrom
ananya4khandelwal:first-pr-docs
Closed

docs: clarify usage of option with multiple values#1517
ananya4khandelwal wants to merge 2 commits intofastapi:masterfrom
ananya4khandelwal:first-pr-docs

Conversation

@ananya4khandelwal
Copy link

No description provided.

@github-actions github-actions bot added the docs Improvements or additions to documentation label Feb 4, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

📝 Docs preview

Last commit 0063646 at: https://56b479b2.typertiangolo.pages.dev

Copy link
Member

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for your interest in contributing to Typer!

These Python examples in the docs_src shouldn't get doc strings. They are used in the tutorial on the documentation site, where the additional information is given in the surrounding text. If we add docstrings, that will make the doc pages too verbose:

Image

cf https://56b479b2.typertiangolo.pages.dev/tutorial/multiple-values/options-with-multiple-values/

As such, I'll go ahead and close this.

@svlandeg svlandeg closed this Feb 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants