Skip to content

Document force_union_syntax and force_uppercase_builtins #16048

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

Merged
sobolevn merged 3 commits into from
Sep 5, 2023
Merged

Document force_union_syntax and force_uppercase_builtins #16048

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b3e3f56
Document `force_union_syntax` and `force_lowercase_builtins`
sobolevn Sep 5, 2023
3d2b247
Typo
sobolevn Sep 5, 2023
44fcc2f
Apply suggestions from code review
sobolevn Sep 5, 2023
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
13 changes: 13 additions & 0 deletions docs/source/config_file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -816,6 +816,19 @@ These options may only be set in the global section (``[mypy]``).

Show absolute paths to files.

.. confval:: force_lowercase_builtins

:type: boolean
:default: False

Force to use ``List`` instead of ``list`` .
Copy link
Copy Markdown
Member

@AlexWaygood AlexWaygood Sep 5, 2023

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

Copy link
Copy Markdown
Member Author

@sobolevn sobolevn Sep 5, 2023

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?

Copy link
Copy Markdown
Member

@AlexWaygood AlexWaygood Sep 5, 2023

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 👍


.. confval:: force_union_syntax

:type: boolean
:default: False

Force to use ``Union[]`` type instead of ``|`` operator.
Comment thread
sobolevn marked this conversation as resolved.
Outdated

Incremental mode
****************
Expand Down
⚡