Skip to content

Fix inconsistent strict_optional documentation #21661

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

Open
BHUVANSH855 wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −6
Open

Fix inconsistent strict_optional documentation #21661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion docs/source/command_line.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,8 @@ The following flags adjust how mypy handles values of type ``None``.
.. warning::

``--no-strict-optional`` is evil. Avoid using it and definitely do
not use it without understanding what it does.
not use it without understanding what it does. See
:ref:`Kinds of types <strict_optional>` for more information.

@A5rocks A5rocks Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this say Kinds of types? Why do you need to link this when the documentation is right above?



.. _configuring-warnings:
Expand Down
12 changes: 7 additions & 5 deletions docs/source/config_file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,15 +618,17 @@ section of the command line docs.
:type: boolean
:default: True

Effectively disables checking of optional
types and ``None`` values. With this option, mypy doesn't
generally check the use of ``None`` values -- it is treated
as compatible with every type.
Enables checking of optional types and ``None`` values.

@A5rocks A5rocks Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to explain what the default does, IMO. Instead, explain what disabling this does. The previous documentation was better, it just needed a "When set to False" before it.

Setting this option to ``false`` effectively disables checking
of optional types and ``None`` values. With
``strict_optional = false``, mypy doesn't generally check the use
of ``None`` values -- it is treated as compatible with every type.

.. warning::

``strict_optional = false`` is evil. Avoid using it and definitely do
not use it without understanding what it does.
not use it without understanding what it does. See
:ref:`Kinds of types <strict_optional>` for more information.

@A5rocks A5rocks Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same.



Configuring warnings
Expand Down
Loading