From 96ee5cef2b45bd2e8ec84e3d0b3ecb3dcc924ca7 Mon Sep 17 00:00:00 2001 From: Thibaut Voirand Date: Fri, 29 Nov 2024 11:53:11 +0100 Subject: [PATCH 1/2] Fix minor inconsistencies in tutorial --- docs/tutorial/commands/one-or-multiple.md | 2 +- docs/tutorial/commands/options.md | 2 +- docs/tutorial/first-steps.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tutorial/commands/one-or-multiple.md b/docs/tutorial/commands/one-or-multiple.md index b6afb92dc0..f89c03c84b 100644 --- a/docs/tutorial/commands/one-or-multiple.md +++ b/docs/tutorial/commands/one-or-multiple.md @@ -129,7 +129,7 @@ Usage: main.py [OPTIONS] COMMAND [ARGS]... Creates a single user Hiro Hamada. - In the next version it will create 5 users more. + In the next version it will create 5 more users. Options: --install-completion Install completion for the current shell. diff --git a/docs/tutorial/commands/options.md b/docs/tutorial/commands/options.md index 1d5567f876..9973f3af11 100644 --- a/docs/tutorial/commands/options.md +++ b/docs/tutorial/commands/options.md @@ -35,7 +35,7 @@ Commands: create delete delete-all - info + init ``` diff --git a/docs/tutorial/first-steps.md b/docs/tutorial/first-steps.md index 1f4fc35e1a..3c17ea42ca 100644 --- a/docs/tutorial/first-steps.md +++ b/docs/tutorial/first-steps.md @@ -458,7 +458,7 @@ In reality, the parameters that require an order can be made *optional* too. And ### In **Typer** -To try and make it a bit easier, we'll normally use the words "parameter" or "argument" to refer to Python functions. +To try and make it a bit easier, we'll normally use the words "parameter" or "argument" to refer to "Python functions parameters" or "Python functions arguments". We'll use ***CLI argument*** to refer to those *CLI parameters* that depend on the specific order. That are **required** by default. From 6f06c9eced87483fcd2186a320d0eb559a251dbe Mon Sep 17 00:00:00 2001 From: Thibaut Voirand Date: Fri, 29 Nov 2024 16:20:16 +0100 Subject: [PATCH 2/2] Update wording in tutorial code --- docs_src/commands/one_or_multiple/tutorial002.py | 2 +- .../test_commands/test_one_or_multiple/test_tutorial002.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs_src/commands/one_or_multiple/tutorial002.py b/docs_src/commands/one_or_multiple/tutorial002.py index db786fc235..351f3df4f3 100644 --- a/docs_src/commands/one_or_multiple/tutorial002.py +++ b/docs_src/commands/one_or_multiple/tutorial002.py @@ -13,7 +13,7 @@ def callback(): """ Creates a single user Hiro Hamada. - In the next version it will create 5 users more. + In the next version it will create 5 more users. """ diff --git a/tests/test_tutorial/test_commands/test_one_or_multiple/test_tutorial002.py b/tests/test_tutorial/test_commands/test_one_or_multiple/test_tutorial002.py index e3b2b013d8..36c796bd5c 100644 --- a/tests/test_tutorial/test_commands/test_one_or_multiple/test_tutorial002.py +++ b/tests/test_tutorial/test_commands/test_one_or_multiple/test_tutorial002.py @@ -14,7 +14,7 @@ def test_help(): result = runner.invoke(app, ["--help"]) assert result.exit_code == 0 assert "Creates a single user Hiro Hamada." in result.output - assert "In the next version it will create 5 users more." in result.output + assert "In the next version it will create 5 more users." in result.output assert "Commands" in result.output assert "create" in result.output