Sphinx Docstring parameter descriptions "key" and "keyword" do not put a new line in "rendered" docstring. #2689
Replies: 4 comments
-
I'm also having the similar issue , see #1662 |
Beta Was this translation helpful? Give feedback.
-
As a Sphinx user it would definitely be very helpful to have some of the basics of the reST format be supported for docstring rendering on hover. |
Beta Was this translation helpful? Give feedback.
-
Is there presently an extension that creates the desired docstring display behavior? |
Beta Was this translation helpful? Give feedback.
-
Moving this issue to discussion as an enhancement request for comments and upvotes. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Environment data
Expected behaviour
:key kwarg1:
should appear on a new line, as it is valid format for ReST:https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists
param, parameter, arg, argument, key, keyword: Description of a parameter.
Actual behaviour
keyword args denoted with

:key kwarg1:
is not put on a new lineLogs
Code Snippet / Additional information
Beta Was this translation helpful? Give feedback.
All reactions