Skip to content

Commit

Permalink
minor improvements to typeCheckingMode documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DetachHead committed Mar 1, 2025
1 parent 47d499a commit b008ea8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/benefits-over-pyright/better-defaults.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ we believe that type checkers and linters should be as strict as possible by def

used to be `"basic"`, but now defaults to `"recommended"`, which enables all diagnostic rules by default. this may seem daunting at first, however we have some solutions to address some concerns users may have with this mode:

- less severe diagnostic rules are reported as warnings instead of errors. this reduces [alarm fatigue](https://en.wikipedia.org/wiki/Alarm_fatigue) while still ensuring that the user is made aware of all potentential issues that basedpyright can detect. `failOnWarnings` is also enabled by default in this mode, which causes the CLI to exit with a non-zero exit code if any warnings are detected. you disable this behavior by setting `failOnWarnings` to `false`.
- less severe diagnostic rules are reported as warnings instead of errors. this reduces [alarm fatigue](https://en.wikipedia.org/wiki/Alarm_fatigue) while still ensuring that you're made aware of all potentential issues that basedpyright can detect. [`failOnWarnings`](../configuration/config-files.md#failOnWarnings) is also enabled by default in this mode, which causes the CLI to exit with a non-zero exit code if any warnings are detected. you disable this behavior by setting `failOnWarnings` to `false`.
- we support [baselining](./baseline.md) to allow for easy adoption of more strict rules in existing codebases.
- we've added a new setting, [`allowedUntypedLibraries`](../configuration/config-files.md#allowedUntypedLibraries) which allows you to turn off rules about unknown types on a per-module basis, which can be useful when working with third party packages that aren't properly typed.

Expand Down

0 comments on commit b008ea8

Please sign in to comment.