Fix #9944 (LaTeX writer visit_desc_content()) #9946
Merged
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.
Relates #9926
With this, the following
produces
Comparing to the output shown in issue #9944, it only fixes the vertical space for the option with note and nested declaration case, not for the note at start of function description.
This PR removes from LaTeX markup an
~
which was added (14 years ago) at 3761223 to fix some "bad formatting issue in case of empty description".(edit after further investigation) the
~
was needed at least in nested cases like thecpp
example above. Without it and at Sphinx<1.5
thecpp
example above gives mangled pdf output.But since
1.5
, the LaTeX mark-up adds\pysigstartmultiline/\pysigstopmultiline
pairs. The\pysigstopmultiline
appears to fix the same issue but without the extra spacing. So it seems~
should not be inserted, at least in such examples.note: I did not need to update tests as apparently no unit test existed to check for the
~
insertion in latex object descriptions in some cases.this PR replaces #9945 which was accidentally closed from renaming the branch at my fork underlying it