Skip to content

Commit

Permalink
📝 Fix minor inconsistencies and typos in tutorial (#1067)
Browse files Browse the repository at this point in the history
  • Loading branch information
tvoirand authored Dec 4, 2024
1 parent b88c327 commit dbc335b
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/tutorial/commands/one-or-multiple.md
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
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
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
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
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

0 comments on commit dbc335b

Please sign in to comment.