clarify with non-Optional typing

svlandeg · svlandeg · commit 26c7b41060fc · 2025-01-08T14:23:59.000+01:00
diff --git 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 make sure to provide a "default" value, for example `None`:
+To make a *CLI argument* optional, use `typer.Argument()` and make sure to provide a "default" value, for example `"World"`:
 
 ```Python hl_lines="7"
 {!../docs_src/arguments/optional/tutorial002_an.py!}
@@ -122,14 +122,20 @@ To make a *CLI argument* optional, use `typer.Argument()` and make sure to provi
 Now we have:
 
 ```Python
-name: Annotated[Optional[str], typer.Argument()] = None
+name: Annotated[str, typer.Argument()] = "World"
 ```
 
 Because we are using `typer.Argument()` **Typer** will know that this is a *CLI argument* (no matter if *required* or *optional*).
 
 /// tip
 
-By using `Optional` your editor will be able to know that the value *could* be `None`, and will be able to warn you if you do something assuming it is a `str` that would break if it was `None`.
+If you want the default value to be `None`, you have to additionally declare the parameter to be of type `Optional`, which will tell your editor that the value of this parameter can be `None`:
+
+```Python
+name: Annotated[Optional[str], typer.Argument()] = None
+```
+
+Your editor can then warn you if you do something assuming it is a `str` that would break if it was `None`.
 
 ///
 
diff --git a/docs_src/arguments/optional/tutorial002.py b/docs_src/arguments/optional/tutorial002.py
@@ -1,13 +1,8 @@
-from typing import Optional
-
 import typer
 
 
-def main(name: Optional[str] = typer.Argument(default=None)):
-    if name is None:
-        print("Hello World!")
-    else:
-        print(f"Hello {name}")
+def main(name: str = typer.Argument(default="World")):
+    print(f"Hello {name}!")
 
 
 if __name__ == "__main__":
diff --git a/docs_src/arguments/optional/tutorial002_an.py b/docs_src/arguments/optional/tutorial002_an.py
@@ -1,14 +1,9 @@
-from typing import Optional
-
 import typer
 from typing_extensions import Annotated
 
 
-def main(name: Annotated[Optional[str], typer.Argument()] = None):
-    if name is None:
-        print("Hello World!")
-    else:
-        print(f"Hello {name}")
+def main(name: Annotated[str, typer.Argument()] = "World"):
+    print(f"Hello {name}!")
 
 
 if __name__ == "__main__":
