LaTeX: improve behavious of \pysigline and \pysiglinewithargsret in case of multi-line signature
#8997
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks as always! merging |
jfbu
added a commit
to jfbu/sphinx
that referenced
this pull request
Mar 15, 2021
Reason is that mark-up such as this:
.. attribute:: state
state_machine
The state and state machine which controls the parsing. Used for
``nested_parse``.
generates two `\pysigline` each with `\phantomsection`. The latex code
to get good vertical spacing between label and its description, if label
``\parbox`` is multi-line, cause in this context the two (generally,
single-line) labels to be stacked vertically with no spacing.
This commit keeps the ``\parbox`` which fixes sphinx-doc#8980, but drops the
attempt to correct vertical distance to description, so as to not alter
the possibly more common use case of items with common description.
jfbu
added a commit
that referenced
this pull request
Mar 15, 2021
LaTeX: partially revert #8997 for \pysigline
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Bugfix
Closes: #7241, #8980, #8995
Regarding #7241, the fix is minimal it produces output like this
The mechanism for signature works in indented context like this (which uses "quoted" indentation so it is on both sides)
An example from our docs:
with this PR:
without this PR:
Notice also vertical spacing between signature and description is improved.
Relates indirectly: #1514
No direct incidence as
\pysiglinewithargsretalready used a\parboxwe are only adding\raggedrightand a finalstrut. But mentioning #1514 in this context due to recent #1514 (comment), and also because the above screenshots show that indeed achieving one argument per line would be much better. But this PR is not involved in this directly.