📝 Update optional CLI argument section in tutorial with Annotated (#983)

Co-authored-by: Sofie Van Landeghem <[email protected]>
Co-authored-by: svlandeg <[email protected]>
Co-authored-by: Sebastián Ramírez <[email protected]>

Author: 3 people

docs/tutorial/arguments/optional.md

@@ -109,24 +109,18 @@ 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 `typer.Argument()` and make sure to provide a "default" value, for example `"World"`:
 
-{* docs_src/arguments/optional/tutorial002_an.py hl[7] *}
+{* docs_src/arguments/optional/tutorial002_an.py hl[5] *}
 
 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`.
-
-///
-
 Check the help:
 
 <div class="termy">

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__":

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__":