and more docs fixes

Author: svlandeg

docs/tutorial/commands/arguments.md

@@ -10,7 +10,10 @@ The same way as with a CLI application with a single command, subcommands (or ju
 // Check the help for create
 $ python main.py create --help
 
-Usage: main.py create [OPTIONS] username
+Usage: main.py create [OPTIONS] {username}
+
+Arguments:
+  username  [required]
 
 Options:
   --help  Show this message and exit.

docs/tutorial/commands/callback.md

@@ -67,7 +67,7 @@ Just created a user
 // Notice that --verbose belongs to the callback, it has to go before create or delete ⛔️
 $ python main.py create --verbose Camila
 
-Usage: main.py create [OPTIONS] username
+Usage: main.py create [OPTIONS] {username}
 Try "main.py create --help" for help.
 
 Error: No such option: --verbose

docs/tutorial/commands/help.md

@@ -24,8 +24,8 @@ Options:
   --help                Show this message and exit.
 
 Commands:
-  create      Create a new user with 'username'.
-  delete      Delete a user with 'username'.
+  create      Create a new user with username.
+  delete      Delete a user with username.
   delete-all  Delete ALL users in the database.
   init        Initialize the users database.
 
@@ -36,7 +36,7 @@ $ python main.py create --help
 
 Usage: main.py create [OPTIONS] {username}
 
-  Create a new user with 'username'.
+  Create a new user with username.
 
 Options:
   --help  Show this message and exit.
@@ -46,7 +46,7 @@ $ python main.py delete --help
 
 Usage: main.py delete [OPTIONS] {username}
 
-  Delete a user with 'username'.
+  Delete a user with username.
 
   If --force is not used, will ask for confirmation.
 
@@ -112,10 +112,10 @@ Options:
   --help                Show this message and exit.
 
 Commands:
-  create  Create a new user with 'username'.
-  delete  Delete a user with 'username'.
+  create  Create a new user with username.
+  delete  Delete a user with username.
 
-// It uses "Create a new user with 'username'." instead of "Some internal utility function to create."
+// It uses "Create a new user with username." instead of "Some internal utility function to create."
 ```
 
 </div>
@@ -257,7 +257,7 @@ $ python main.py delete --help
 
 <b> </b><font color="#F4BF75"><b>Usage: </b></font><b>main.py delete [OPTIONS] {username}                     </b>
 <b>                                                                     </b>
- <font color="#F92672"><b>Delete</b></font> a user with <i>'username'</i>.
+ <font color="#F92672"><b>Delete</b></font> a user with <i>username</i>.
 
 <font color="#A5A5A1">╭─ Arguments ───────────────────────────────────────────────────────╮</font>
 <font color="#A5A5A1">│ </font><font color="#F92672">*</font>    username      <font color="#F4BF75"><b>&lt;str&gt;</b></font>  The username to be <font color="#F92672">deleted</font>              │
@@ -319,7 +319,7 @@ $ python main.py delete --help
 
 <b> </b><font color="#F4BF75"><b>Usage: </b></font><b>main.py delete [OPTIONS] {username}                     </b>
 <b>                                                                     </b>
- <b>Delete</b> a user with <i>'username'</i>.
+ <b>Delete</b> a user with <i>username</i>.
 
 <font color="#A5A5A1">╭─ Arguments ───────────────────────────────────────────────────────╮</font>
 <font color="#A5A5A1">│ </font><font color="#F92672">*</font>    username      <font color="#F4BF75"><b>&lt;str&gt;</b></font>  The username to be <b>deleted</b>              │

docs/tutorial/options/callback-and-context.md

@@ -61,12 +61,12 @@ utils  -- Extra utility commands for Typer apps.
 $ typer ./main.py run --help
 
 // You get a help text with your CLI options as you normally would
-Usage: typer run [OPTIONS]
+Usage: typer [PATH_OR_MODULE] run [OPTIONS]
 
   Run the provided Typer app.
 
 Options:
-  --name <str> [required]
+  --name <str> 
   --help       Show this message and exit.
 
 // Then try completion with your program

docs/tutorial/options/required.md

@@ -59,6 +59,9 @@ Hello Camila Gutiérrez
 // And if you check the help
 $ python main.py --help
 
+Arguments:
+  name  [required]
+
 Usage: main.py [OPTIONS] {name}
 
 Options:

docs/tutorial/options/version.md

@@ -34,7 +34,7 @@ Usage: main.py [OPTIONS]
 
 Options:
   --version
-  --name <str>
+  --name <str>          [default: World]
   --help                Show this message and exit.
 
 

docs/tutorial/typer-command.md

@@ -169,7 +169,7 @@ Then you can call it with:
 
 ```console
 $ typer main.py run --help
-Usage: typer run [OPTIONS]
+Usage: typer [PATH_OR_MODULE] run [OPTIONS]
 
   Say hi to someone, by default to the World.
 
@@ -196,7 +196,7 @@ For example:
 
 ```console
 $ typer my_package.main run --help
-Usage: typer run [OPTIONS]
+Usage: typer [PATH_OR_MODULE] run [OPTIONS]
 
 Options:
   --name <str>
@@ -305,14 +305,14 @@ $ awesome-cli [OPTIONS] COMMAND [ARGS]...
 
 **Commands**:
 
-* `create`: Create a new user with 'username'.
-* `delete`: Delete a user with 'username'.
+* `create`: Create a new user with username.
+* `delete`: Delete a user with username.
 * `delete-all`: Delete ALL users in the database.
 * `init`: Initialize the users database.
 
 ## `awesome-cli create`
 
-Create a new user with 'username'.
+Create a new user with username.
 
 **Usage**:
 

docs_src/commands/help/tutorial001_an_py310.py

@@ -8,7 +8,7 @@
 @app.command()
 def create(username: str):
     """
-    Create a new user with USERNAME.
+    Create a new user with username.
     """
     print(f"Creating user: {username}")
 
@@ -25,7 +25,7 @@ def delete(
     ],
 ):
     """
-    Delete a user with USERNAME.
+    Delete a user with username.
 
     If --force is not used, will ask for confirmation.
     """

docs_src/commands/help/tutorial001_py310.py

@@ -6,7 +6,7 @@
 @app.command()
 def create(username: str):
     """
-    Create a new user with USERNAME.
+    Create a new user with username.
     """
     print(f"Creating user: {username}")
 
@@ -21,7 +21,7 @@ def delete(
     ),
 ):
     """
-    Delete a user with USERNAME.
+    Delete a user with username.
 
     If --force is not used, will ask for confirmation.
     """

docs_src/commands/help/tutorial002_py310.py

@@ -3,15 +3,15 @@
 app = typer.Typer()
 
 
-@app.command(help="Create a new user with USERNAME.")
+@app.command(help="Create a new user with username.")
 def create(username: str):
     """
     Some internal utility function to create.
     """
     print(f"Creating user: {username}")
 
 
-@app.command(help="Delete a user with USERNAME.")
+@app.command(help="Delete a user with username.")
 def delete(username: str):
     """
     Some internal utility function to delete.