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

Jump to bottom

Quick clarification in arguments docs #98

Merged
merged 3 commits into from
Jun 22, 2020
Merged

Quick clarification in arguments docs #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c9775f
Quick clarification in arguments docs
mrcartoonster May 5, 2020
66dc3ee
Fixing typo in CLI Option autocompletion.
mrcartoonster May 5, 2020
a180e00
Merge branch 'master' into typos
tiangolo Jun 22, 2020
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
4 changes: 3 additions & 1 deletion docs/tutorial/arguments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,6 @@ You should document your *CLI arguments* the same way.

## Other uses

`typer.Argument()` has several other use-cases; for data validation, to enable other features, etc. You will learn about these later in the docs.
`typer.Argument()` has several other use cases. Such as for data validation, to enable other features, etc.

You will see about these use cases later in the docs.
2 changes: 1 addition & 1 deletion docs/tutorial/options/autocompletion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ You can also get the raw *CLI parameters*, just a `list` of `str` with everythin
For example, something like `["typer", "main.py", "run", "--name"]`.

!!! tip
This would be for advanced scenarios, in most use cases you would be better of using the context.
This would be for advanced scenarios, in most use cases you would be better off using the context.

But it's still possible if you need it.

Expand Down