[docs] Include a real listing of the flags strict enables in the online documentation #19062
+67
−19
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
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
This comment has been minimized.
This comment has been minimized.
sterliakov
reviewed
May 10, 2025
for more information, see https://pre-commit.ci
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
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
without loss of generality
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
sterliakov
reviewed
May 12, 2025
|
|
||
| def write_doc(self, docname: str, doctree: document) -> None: | ||
| super().write_doc(docname, doctree) | ||
| self._ref_to_doc.update({_id: docname for _id in doctree.ids}) | ||
|
|
||
| def _add_strict_list(self) -> None: | ||
| strict_flags: list[str] |
There was a problem hiding this comment.
Why is this explicit decl necessary?
There was a problem hiding this comment.
It's not, I just left it in to document the type. What with define_options being so far away and us only using the middle of its tuple. I don't feel strongly about it one way or the other 🤷
| return parser, strict_flag_names, strict_flag_assignments | ||
|
|
||
|
|
||
| def process_options( |
There was a problem hiding this comment.
Amazing, this func that contains some real logic is only 200 LOC now, much better than 1000+ to scroll!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #19061
Currently, https://mypy.readthedocs.io/en/stable/command_line.html just says
Which makes cross-referencing the documentation difficult. Instead, there should be the same list there as appears when running
mypy --help: egIdeally this section would be automatically generated from the code.
This pull request accomplishes this.