Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Fix outdated optional *CLI argument* section in tutorial #983

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

📝 Fix outdated optional *CLI argument* section in tutorial #983

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
729182b
Fix outdated optional *CLI argument* section in tutorial
gkeuccsr Sep 9, 2024
014882c
Rephrase
svlandeg Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/tutorial/arguments/optional.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ name: str

Now, finally what we came for, an optional *CLI argument*.

To make a *CLI argument* optional, use `typer.Argument()` and pass a different "default" as the first parameter to `typer.Argument()`, for example `None`:
To make a *CLI argument* optional, use `Optional[X]` type for `Annotated` and provide a "default" value for function parameter, for example `None`:
svlandeg marked this conversation as resolved.
Show resolved Hide resolved

```Python hl_lines="7"
{!../docs_src/arguments/optional/tutorial002_an.py!}
Expand Down
Loading