Skip to content

[docs] Include a real listing of the flags strict enables in the online documentation #19062

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

Jump to bottom
Merged
merged 17 commits into from
Aug 2, 2025
Merged

[docs] Include a real listing of the flags strict enables in the online documentation #19062

merged 17 commits into from
Aug 2, 2025
+67 −19

Conversation

wyattscarpenter
Copy link
Contributor

Fixes #19061

Currently, https://mypy.readthedocs.io/en/stable/command_line.html just says

You can see the list of flags enabled by strict mode in the full mypy --help output.

Which makes cross-referencing the documentation difficult. Instead, there should be the same list there as appears when running mypy --help: eg

--warn-unused-configs, --disallow-any-generics,
--disallow-subclassing-any, --disallow-untyped-
calls, --disallow-untyped-defs, --disallow-
incomplete-defs, --check-untyped-defs, --disallow-
untyped-decorators, --warn-redundant-casts,
--warn-unused-ignores, --warn-return-any, --no-
implicit-reexport, --strict-equality, --extra-
checks

Ideally this section would be automatically generated from the code.

This pull request accomplishes this.

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@wyattscarpenter wyattscarpenter marked this pull request as ready for review May 9, 2025 09:52
sterliakov
sterliakov reviewed May 10, 2025
View reviewed changes
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@wyattscarpenter
Move the start of the list to the generation code
5a6ad43 
I remembered that sometimes this documentation gets processed into other formats, like a man page. I'm not sure what the process is there, but let's save them a little potential embarassment of introducing but not having a list
@wyattscarpenter
remove syntax that causes annoying error message during generation
b6b3863 
without loss of generality
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@wyattscarpenter wyattscarpenter mentioned this pull request May 11, 2025
Open
sterliakov
sterliakov reviewed May 12, 2025
View reviewed changes
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions
Copy link
Contributor

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

hauntsaninja
hauntsaninja approved these changes Aug 2, 2025
View reviewed changes
Copy link
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

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

Nice!

@hauntsaninja hauntsaninja merged commit 82ad62c into python:master Aug 2, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hauntsaninja hauntsaninja hauntsaninja approved these changes

@sterliakov sterliakov sterliakov approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Should include a real listing of the flags strict enables in the online documentation.
3 participants
@wyattscarpenter @hauntsaninja @sterliakov
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy