DOC: Fix selection of parameter names in HTML theme #21435
Merged
Conversation
This file contains 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
Parameters are written in HTML as (leaving out some internal classes): ``` <strong>name</strong><span class="classifier"><a><code><span>TypeName</span></code></a></span> ``` but in rendered form there's a colon between the name and type. This colon is inserted virtually using CSS, but since it doesn't exist, the browser thinks both sides are part of the same word. Styling the virtual text as inline block makes it be treated as a break, but also makes it apply vertical margins, so we need to set those to zero again. Fixes matplotlib#21432.
|
Thanks for the quick fix! |
dstansby
approved these changes
Oct 23, 2021
|
Going to merge with one review as this is essentially vendoring an accepted upstream fix. |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Oct 23, 2021
dstansby
added a commit
that referenced
this pull request
Oct 23, 2021
…435-on-v3.5.x Backport PR #21435 on branch v3.5.x (DOC: Fix selection of parameter names in HTML theme)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Summary
Parameters are written in HTML as (leaving out some internal classes):
but in rendered form there's a colon between the name and type. This colon is inserted virtually using CSS, but since it doesn't exist, the browser thinks both sides are part of the same word.
Styling the virtual text as inline block makes it be treated as a break, but also makes it apply vertical margins, so we need to set those to zero again.
See also sphinx-doc/sphinx#9763
Fixes #21432.
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).