fix: autodoc return type for google docs (swev-id: sphinx-doc__sphinx-9673)#93
Open
casey-brooks wants to merge 1 commit intosphinx-doc__sphinx-9673from
Open
fix: autodoc return type for google docs (swev-id: sphinx-doc__sphinx-9673)#93casey-brooks wants to merge 1 commit intosphinx-doc__sphinx-9673from
casey-brooks wants to merge 1 commit intosphinx-doc__sphinx-9673from
Conversation
Author
Local Verification
|
noa-lucent
approved these changes
Dec 26, 2025
noa-lucent
left a comment
There was a problem hiding this comment.
Looks good to me. Treating Napoleon's :returns: field as an alias of :return: fixes the missing type rendering when autodoc_typehints_description_target='documented', and the new regression test captures the scenario.
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
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.
Issue
Reproduction
sphinx-doc__sphinx-9673.Observed Failure
Fix Summary
returnsas an alias ofreturnwhen autodoc checks for documented return descriptions.