From 729182b33170e6c3701524ac718ec2805e0e2d9d Mon Sep 17 00:00:00 2001 From: gkeuccsr <166070166+gkeuccsr@users.noreply.github.com> Date: Mon, 9 Sep 2024 22:24:25 +0200 Subject: [PATCH 1/2] Fix outdated optional *CLI argument* section in tutorial To match the example, description is updated --- docs/tutorial/arguments/optional.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/arguments/optional.md b/docs/tutorial/arguments/optional.md index e33b9cdc46..a0690d0cf2 100644 --- a/docs/tutorial/arguments/optional.md +++ b/docs/tutorial/arguments/optional.md @@ -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`: ```Python hl_lines="7" {!../docs_src/arguments/optional/tutorial002_an.py!} From 014882c5f80994917769d6cb7d33bea4f69c2f3f Mon Sep 17 00:00:00 2001 From: Sofie Van Landeghem Date: Tue, 10 Sep 2024 11:03:28 +0200 Subject: [PATCH 2/2] Rephrase --- docs/tutorial/arguments/optional.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/arguments/optional.md b/docs/tutorial/arguments/optional.md index a0690d0cf2..728b1e6460 100644 --- a/docs/tutorial/arguments/optional.md +++ b/docs/tutorial/arguments/optional.md @@ -113,7 +113,7 @@ name: str Now, finally what we came for, an optional *CLI argument*. -To make a *CLI argument* optional, use `Optional[X]` type for `Annotated` and provide a "default" value for function parameter, for example `None`: +To make a *CLI argument* optional, use `typer.Argument()` and make sure to provide a "default" value, for example `None`: ```Python hl_lines="7" {!../docs_src/arguments/optional/tutorial002_an.py!}