Fix documentation field-list label rendering#12585
Conversation
Merging this PR will not alter performance
Comparing Footnotes
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #12585 +/- ##
==========================================
+ Coverage 98.77% 98.94% +0.16%
==========================================
Files 128 131 +3
Lines 44890 46683 +1793
Branches 2383 2421 +38
==========================================
+ Hits 44340 46189 +1849
+ Misses 390 369 -21
+ Partials 160 125 -35
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
@aiolibsbot review |
PR Review — Fix documentation field-list label renderingSmall, low-risk CSS-only change with a changelog fragment. The mechanics are fine — selector is valid, no behavioral or security risk, codecov/codspeed are green. Two things worth addressing before merge: (1) the rule lives in 🟢 Suggestions1. Selector scope and theme considerations (`docs/_static/css/logo-adjustments.css`, L8-10)The selector
Also note this CSS file is named 2. Changelog attribution should be aiolibsbot (`CHANGES/4127.doc.rst`, L1-2)Per the repo's attribution convention for bot-drafted PRs, the 3. No visual verification providedThe PR description states documentation should render more readably but doesn't include before/after screenshots. For a pure-CSS doc fix, a screenshot pair (or a link to a built docs preview) is the easiest way for reviewers to validate that the rule actually solves issue #4127 without regressing other field-list usages (e.g. Checklist
SummarySmall, low-risk CSS-only change with a changelog fragment. The mechanics are fine — selector is valid, no behavioral or security risk, codecov/codspeed are green. Two things worth addressing before merge: (1) the rule lives in Automated review by Kōan352718c |
What do these changes do?
Adds a small CSS rule for Sphinx field-list labels so labels such as
Parameters:keep enough width instead of rendering as a cramped vertical column.Are there changes in behavior for the user?
No runtime behavior changes. Documentation pages should render parameter labels more readably.
Is it a substantial burden for the maintainers to support this?
No. This is a small documentation stylesheet adjustment with minimal maintenance impact.
Related issue number
Fixes #4127.
Checklist
CONTRIBUTORS.txtCHANGES/folder<issue_or_pr_num>.<type>.rst(e.g.588.bugfix.rst)number after creating the PR
.bugfix: A bug fix for something the maintainers deemed animproper undesired behavior that got corrected to match
pre-agreed expectations.
.feature: A new behavior, public APIs. That sort of stuff..deprecation: A declaration of future API removals and breakingchanges in behavior.
.breaking: When something public is removed in a breaking way.Could be deprecated in an earlier release.
.doc: Notable updates to the documentation structure or buildprocess.
.packaging: Notes for downstreams about unobvious side effectsand tooling. Changes in the test invocation considerations and
runtime assumptions.
.contrib: Stuff that affects the contributor experience. e.g.Running tests, building the docs, setting up the development
environment.
.misc: Changes that are hard to assign to any of the abovecategories.
for example: