-
Notifications
You must be signed in to change notification settings - Fork 101
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.
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
rtype not separated from previous paragraph #431
Comments
That sounds reasonable, if you add a test validating test a PR is welcome. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I've run into a situation where
sphinx-autodoc-typehints
is inserting the rtype signature without creating space between rtype and the previous paragraph so it isn't being rendered correctly in the final html output:Instead what I expected to see is:
I am using
sphinx-autodoc-typehints==2.0.0
.To help, I've created a repository with a MRE here: https://github.com/tjsmart/sphinx-autodoc-typehints-rtype-issue.
I'm not sure I understand enough about the codebase but it seems to me the problematic area is inside
_inject_rtype
.I noticed a related ticket from a few years ago introduced these lines of code:
I wonder if it would be better to just explicitly check if the previous line is not blank. If it isn't then insert a blank line to make sure that rtype won't be joined with the previous paragraph of text. For example we could change these lines to be:
The text was updated successfully, but these errors were encountered: