Conversation
codefiles
force-pushed
the
ruff-ann
branch
2 times, most recently
from
September 2, 2026 10:16
c7fbf36 to
1a5bfd6
Compare
codefiles
commented
Sep 19, 2026
Comment on lines
+12
to
+19
| def process_docstring( | ||
| app: Sphinx, | ||
| what: str, | ||
| name: str, | ||
| obj: Any, | ||
| options: Any, | ||
| lines: list[str], | ||
| ) -> None: |
Contributor
Author
There was a problem hiding this comment.
Using a str rather than redefine the Literal or import _AutodocObjType since it is internal.
References:
- https://github.com/sphinx-doc/sphinx/blob/e44a40eb2f810558ccd9da1425421270ccb81351/sphinx/application.py#L714-L720
- https://github.com/sphinx-doc/sphinx/blob/e44a40eb2f810558ccd9da1425421270ccb81351/sphinx/ext/autodoc/_event_listeners.py#L15-L26
- https://github.com/sphinx-doc/sphinx/blob/e44a40eb2f810558ccd9da1425421270ccb81351/sphinx/ext/autodoc/_property_types.py#L19-L30
Contributor
Author
|
This has overlap with mypy functionality. That is not a problem because Ruff is fast, not noticeably any slower with this enabled, and the error messages are more understandable. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Use
Anyfor missing types soANN001,ANN002, andANN003can be enabled.Reference:
https://docs.astral.sh/ruff/rules/#flake8-annotations-ann