Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Fix minor inconsistencies and typos in tutorial #1067

Merged
merged 2 commits into from
Dec 4, 2024
Merged

📝 Fix minor inconsistencies and typos in tutorial #1067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96ee5ce
Fix minor inconsistencies in tutorial
tvoirand Nov 29, 2024
6f06c9e
Update wording in tutorial code
tvoirand Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/tutorial/commands/one-or-multiple.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/commands/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Commands:
create
delete
delete-all
info
init
```

</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/first-steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs_src/commands/one_or_multiple/tutorial002.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""


Expand Down
2 changes: 1 addition & 1 deletion tests/test_tutorial/test_commands/test_one_or_multiple/test_tutorial002.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading