more fixes of help displays in docs

Author: svlandeg

docs/tutorial/commands/one-or-multiple.md

@@ -23,7 +23,7 @@ $ python main.py Camila
 Hello Camila
 
 // Asking for help
-$ python main.py
+$ python main.py --help
 
 Usage: main.py [OPTIONS] {name}
 

docs/tutorial/options/help.md

@@ -67,7 +67,7 @@ And below you will see other panels for the *CLI options* that have a custom pan
 ```console
 $ python main.py --help
 
-<b> </b><font color="#F4BF75"><b>Usage: </b></font><b>main.py [OPTIONS] name                                </b>
+<b> </b><font color="#F4BF75"><b>Usage: </b></font><b>main.py [OPTIONS] {name}                                </b>
 <b>                                                                     </b>
  Say hi to 'name', optionally with a <font color="#A1EFE4"><b>--lastname</b></font>.
  If <font color="#6B9F98"><b>--formal</b></font><font color="#A5A5A1"> is used, say hi very formally.                          </font>

docs/tutorial/options/required.md

@@ -59,11 +59,11 @@ Hello Camila Gutiérrez
 // And if you check the help
 $ python main.py --help
 
+Usage: main.py [OPTIONS] {name}
+
 Arguments:
   name  [required]
 
-Usage: main.py [OPTIONS] {name}
-
 Options:
   --lastname <str>      [required]
   --help                Show this message and exit.

docs/tutorial/parameter-types/index.md

@@ -50,7 +50,7 @@ $ python main.py Camila --age 15.3
 Usage: main.py [OPTIONS] {name}
 Try "main.py --help" for help.
 
-Error: Invalid value for '--age': '15.3' is not a valid integer
+Error: Invalid value for '--age': '15.3' is not a valid int.
 
 // Because 15.3 is not an integer (it's a float)
 ```

docs/tutorial/parameter-types/number.md

@@ -16,7 +16,7 @@ Check it:
 $ python main.py --help
 
 // Notice the extra range information in the help text for --age and --score
-Usage: main.py [OPTIONS] ID
+Usage: main.py [OPTIONS] {ID}
 
 Arguments:
   ID  [required]
@@ -36,23 +36,23 @@ ID is 5
 // Pass an invalid ID
 $ python main.py 1002
 
-Usage: main.py [OPTIONS] ID
+Usage: main.py [OPTIONS] {ID}
 Try "main.py --help" for help.
 
 Error: Invalid value for 'ID': 1002 is not in the range 0<=x<=1000.
 
 // Pass an invalid age
 $ python main.py 5 --age 15
 
-Usage: main.py [OPTIONS] ID
+Usage: main.py [OPTIONS] {ID}
 Try "main.py --help" for help.
 
 Error: Invalid value for '--age': 15 is not in the range x>=18.
 
 // Pass an invalid score
 $ python main.py 5 --age 20 --score 100.5
 
-Usage: main.py [OPTIONS] ID
+Usage: main.py [OPTIONS] {ID}
 Try "main.py --help" for help.
 
 Error: Invalid value for '--score': 100.5 is not in the range x<=100.
@@ -83,7 +83,7 @@ And then, when you pass data that is out of the valid range, it will be "clamped
 // ID doesn't have clamp, so it shows an error
 $ python main.py 1002
 
-Usage: main.py [OPTIONS] ID
+Usage: main.py [OPTIONS] {ID}
 Try "main.py --help" for help.
 
 Error: Invalid value for 'ID': 1002 is not in the range 0<=x<=1000.

docs/tutorial/parameter-types/uuid.md

@@ -34,16 +34,16 @@ Check it:
 // Pass a valid UUID v4
 $ python main.py d48edaa6-871a-4082-a196-4daab372d4a1
 
-USER_ID is d48edaa6-871a-4082-a196-4daab372d4a1
+User ID is d48edaa6-871a-4082-a196-4daab372d4a1
 UUID version is: 4
 
 // An invalid value
 $ python main.py 7479706572-72756c6573
 
-Usage: main.py [OPTIONS] USER_ID
+Usage: main.py [OPTIONS] {user_id}
 Try "main.py --help" for help.
 
-Error: Invalid value for 'USER_ID': 7479706572-72756c6573 is not a valid UUID.
+Error: Invalid value for 'user_id': 7479706572-72756c6573 is not a valid UUID.
 ```
 
 </div>

docs_src/parameter_types/uuid/tutorial001_py310.py

@@ -7,7 +7,7 @@
 
 @app.command()
 def main(user_id: UUID):
-    print(f"USER_ID is {user_id}")
+    print(f"User ID is {user_id}")
     print(f"UUID version is: {user_id.version}")
 
 

tests/test_tutorial/test_parameter_types/test_uuid/test_tutorial001.py

@@ -20,15 +20,15 @@ def test_type_repr():
 def test_main():
     result = runner.invoke(app, ["d48edaa6-871a-4082-a196-4daab372d4a1"])
     assert result.exit_code == 0
-    assert "USER_ID is d48edaa6-871a-4082-a196-4daab372d4a1" in result.output
+    assert "User ID is d48edaa6-871a-4082-a196-4daab372d4a1" in result.output
     assert "UUID version is: 4" in result.output
 
 
 def test_main_with_uuid_object():
     user_id = uuid.UUID("d48edaa6-871a-4082-a196-4daab372d4a1")
     result = runner.invoke(app, [], default_map={"user_id": user_id})
     assert result.exit_code == 0
-    assert "USER_ID is d48edaa6-871a-4082-a196-4daab372d4a1" in result.output
+    assert "User ID is d48edaa6-871a-4082-a196-4daab372d4a1" in result.output
     assert "UUID version is: 4" in result.output