Made diagnosticSeverityOverrides use clearer + added links to and fro #1567
+22
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DetachHead
reviewed
Oct 9, 2025
docs/configuration/config-files.md
Outdated
| ### Type Check Rule Overrides | ||
|
|
||
| The following settings allow more fine grained control over the **typeCheckingMode**. Unless otherwise specified, each diagnostic setting can specify a boolean value (`false` indicating that no error is generated and `true` indicating that an error is generated). Alternatively, a string value of `"none"`, `"hint"`, `"warning"`, `"information"`, or `"error"` can be used to specify the diagnostic level. [see above for more information](#diagnostic-categories) | ||
| The following settings allow more fine grained control over the **typeCheckingMode**. Unless otherwise specified, each diagnostic setting can specify a boolean value (`false` indicating that no error is generated and `true` indicating that an error is generated). Alternatively, a string value of `"none"`, `"hint"`, `"warning"`, `"information"`, or `"error"` can be used to specify the diagnostic level. [see above for more information](#diagnostic-categories), and check the [language server discouraged settings](./language-server-settings.md#discouraged-settings) to learn how to use them in your config (note that as the name implies, you should avoid doing that : use preferably the modes available for **typeCheckingMode**). |
Owner
There was a problem hiding this comment.
the reason they are discouraged isn't because typeCheckingMode is preferred, but rather because we recommend configuring these rules in pyproject.toml or pyrightconfig.json instead. the section you linked explains why:
these options can also be configured using a config file. it's recommended to use either a
pyproject.tomlorpyrightconfig.jsonfile instead of the language server to configure type checking for the following reasons:
- the config should be the same for everybody working on your project. you should commit the config file so that other contributors don't have to manually configure their language server to match yours.
- it ensures that the basedpyright language server behaves the same as the
basedpyrightCLI, which is useful if you have your CI configured to type check your code (you should!)
Owner
There was a problem hiding this comment.
tbh i think this addition should probably just be removed. makes the sentence a bit too long and it looks out of place to direct the reader's attention to something else, only to suggest not using it.
…e editor's main config is discouraged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.