How to document multiline parameters in Python docstring
10 views
Skip to first unread message
RdB
Mar 6, 2020, 11:45:20 AM3/6/20
to sphinx-users
Respecting PEP8, I need to stay under 80 chars long lines. So I have this documentation snippet:
But this renders like this:
Returns:
xy: A tuple containing the x and y coordinates of the \
:class:`BoundaryCurve` computed for the :math:`\xi` values
But this renders like this:
How do I format it to make it "look like" a single line?
RdB
Mar 6, 2020, 11:47:35 AM3/6/20
to sphinx-users
xy: | A tuple containing the x and y coordinates of the
:class:`BoundaryCurve` computed for the :math:`\xi` values
This seems to work ;)
Reply all
Reply to author
Forward
0 new messages