Remove redundant type annotations from Sphinx docstrings - #671
Merged
Merged
Conversation
Pierre-Sassoulas
added this pull request to stack #670
September 29, 2026 13:52
nicoddemus
previously approved these changes
Sep 29, 2026
Pierre-Sassoulas
force-pushed
the
docstring-types
branch
2 times, most recently
from
September 29, 2026 14:34
723bddc to
78199c6
Compare
Annotate _QtMessageCapture.records and the signal name helpers of wait_signal, and drop the now redundant types from their docstrings. SignalInstance moves to wait_signal so both modules can use it. Refs #610 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Use autodoc_typehints = "description" and drop the types from the QtBot docstrings. The Qt aliases are mapped by name so the docs keep showing QWidget and friends instead of Any. Sphinx 9 does not resolve those aliases when nested, so the two affected parameters keep a :type: field. The QTest proxy methods are documented by hand in the class docstring, without a Python signature, so they keep their types. Refs #610 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #610 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Pierre-Sassoulas
force-pushed
the
docstring-types
branch
from
September 29, 2026 15:21
78199c6 to
3abe8ee
Compare
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
2 participants
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.
Last bullet point of #610