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

📝 Fix typos in documentation #761

Merged
merged 6 commits into from
Apr 7, 2024
Merged

📝 Fix typos in documentation #761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e890fda
fix capitalization
svlandeg Mar 18, 2024
5edefae
fix space
svlandeg Mar 18, 2024
c4a89e9
fix in unit test function name
svlandeg Mar 26, 2024
31247d2
update tutorial to have the same default as _an version
svlandeg Mar 26, 2024
d0f4936
Merge branch 'master' into feature/docs_fixes
svlandeg Mar 26, 2024
4ed320f
Merge branch 'master' into feature/docs_fixes
tiangolo Apr 7, 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/help-typer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ As you have seen in the documentation, Typer is built on top of Click.

You can also sponsor:

* Pallets Project (Click maintainers)<a href="https://palletsprojects.com/donate" class="external-link" target="_blank">via the PSF</a> or <a href="https://tidelift.com/subscription/pkg/pypi-click" class="external-link" target="_blank">via Tidelift</a>
* Pallets Project (Click maintainers) <a href="https://palletsprojects.com/donate" class="external-link" target="_blank">via the PSF</a> or <a href="https://tidelift.com/subscription/pkg/pypi-click" class="external-link" target="_blank">via Tidelift</a>

---

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/arguments/optional.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Now let's see an alternative way to create the same *CLI argument*:

If you have an older version, you would get errors when trying to use `Annotated`.

Make sure you Upgrade the Typer version to at least 0.9.0 before using `Annotated`.
Make sure you upgrade the Typer version to at least 0.9.0 before using `Annotated`.

Before, you had this function parameter:

Expand Down
2 changes: 1 addition & 1 deletion docs_src/parameter_types/custom_types/tutorial001.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def parse_custom_class(value: str):

def main(
custom_arg: CustomClass = typer.Argument(parser=parse_custom_class),
custom_opt: CustomClass = typer.Option("Y", parser=parse_custom_class),
custom_opt: CustomClass = typer.Option("Foo", parser=parse_custom_class),
):
print(f"custom_arg is {custom_arg}")
print(f"--custom-opt is {custom_opt}")
Expand Down
2 changes: 1 addition & 1 deletion tests/test_others.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def test_defaults_from_info():
assert value


def test_too_may_parsers():
def test_too_many_parsers():
def custom_parser(value: str) -> int:
return int(value) # pragma: no cover

Expand Down
2 changes: 1 addition & 1 deletion tests/test_tutorial/test_parameter_types/test_custom_types/test_tutorial001.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def test_parse_custom_type():
def test_parse_custom_type_with_default():
result = runner.invoke(app, ["0"])
assert "custom_arg is <CustomClass: value=00>" in result.output
assert "custom-opt is <CustomClass: value=YY>" in result.output
assert "custom-opt is <CustomClass: value=FooFoo>" in result.output


def test_script():
Expand Down
Loading