Skip to content

Commit bb3f090

Browse files
Update docs to reflect --typecheck defaulting to false
Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/d3fd89e4-016d-4137-b9cd-b260d4f41c4b
1 parent 286633a commit bb3f090

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

docs/cli/reference.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
Initialize a new Python project with recommended defaults, including:
66

77
- a `pyproject.toml` file and relevant configuration,
8-
- recommended linters, formatters, spellcheckers, type checkers, and test frameworks (all opt-out),
8+
- recommended linters, formatters, spellcheckers, and test frameworks (all opt-out),
9+
- a recommended type checker (opt-in),
910
- docstring style enforcement (opt-in),
1011
- a recommended git hook framework (opt-in),
1112
- CI services (opt-in),
@@ -20,7 +21,7 @@ Supported options:
2021
- `--lint` to add recommended linters (default; or `--no-lint` to opt-out)
2122
- `--spellcheck` to add a recommended spellchecker (default; or `--no-spellcheck` to opt-out)
2223
- `--test` to add a recommended testing framework (default; or `--no-test` to opt-out)
23-
- `--typecheck` to add a recommended type checker (default; or `--no-typecheck` to opt-out)
24+
- `--typecheck` to add a recommended type checker (but the default is `--no-typecheck`)
2425
- `--hook` to add a recommended git hook framework (but the default is `--no-hook`)
2526
- `--docstyle` to set a docstring style convention for the project.
2627

0 commit comments

Comments
 (0)