-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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.
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
Document force_union_syntax
and force_uppercase_builtins
#16048
Conversation
eb5d0d7
to
b3e3f56
Compare
docs/source/config_file.rst
Outdated
.. confval:: force_lowercase_builtins | ||
|
||
:type: boolean | ||
:default: False | ||
|
||
Force to use ``List`` instead of ``list`` . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment as with force_union_syntax
-- it looks like this option just impacts whether or not the messages mypy displays to the user use PEP-585 syntax. Also: the config option is force_uppercase_builtins
, not force_lowercase_builtins
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this is just about messages. This is why I put these two in "Configuring error messages" category. Is there any better way to describe them?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is why I put these two in "Configuring error messages" category.
Ah, I didn't spot that, sorry!
Is there any better way to describe them?
I think "in error messages" is a useful qualifier -- have made some suggestions in review comments 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about this?
Co-authored-by: Alex Waygood <[email protected]>
force_union_syntax
and force_lowercase_builtins
force_union_syntax
and force_uppercase_builtins
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks!
Should we also document these as command-line options? It looks like |
Users don't know about them: typeddjango/pytest-mypy-plugins#126
Since they are quite important for testing, I think that it is a must to include them.