Collapse multiple retvals into a single bullet list #697
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.
After the change to use Docutils/Sphinx field lists the rendering of
\retval
was a bit icky as there is no direct equivalent.This changes the rendering of them to gather them into a single field. If there are multiple
\retval
s they will be made into a bullet list in the same field body.E.g., for
it now gets compiled into
Note, only the
\reval
s are touched, as they are the ones that mentions a value, but\returns
s are left as individual fields as map directly to the field in Sphinx (is it common to have both\retval
s and\retuns
at the same time?)See also #684 and #687.
Fixes part of #695.