Skip to content

Place rtype after directive #537

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

Merged
merged 1 commit into from
Apr 25, 2025
Merged

Place rtype after directive #537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/sphinx_autodoc_typehints/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,8 @@ def get_insert_index(app: Sphinx, lines: list[str]) -> InsertIndexInfo | None:
continue
line_no = node_line_no(child)
at = max(line_no - 2, 0) if line_no else len(lines)
if lines[at - 1]: # skip if something on this line
break
return InsertIndexInfo(insert_index=at, found_directive=True)

# 5. Otherwise, insert at end
Expand Down
8 changes: 6 additions & 2 deletions tests/test_integration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1397,15 +1397,19 @@ def docstring_with_multiline_note_after_params_epilog_replace(param: int) -> Non
"""
mod.docstring_with_see_also()

Return type:
"str"
Test

See also: more info at <https://example.com>`_.

Return type:
"str"

"""
)
def docstring_with_see_also() -> str:
"""
Test

.. seealso:: more info at <https://example.com>`_.
"""
return ""
Expand Down