Repository navigation
DOC: reorder rcParams - #32449
Open
timhoffm wants to merge 16 commits into
Open
DOC: reorder rcParams#32449timhoffm wants to merge 16 commits into
timhoffm wants to merge 16 commits into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
…- next to other backends
previously the backend subsections were under the subsection "Saving figures"
…ections ("Lines", "Patches", ...)
…n "Lines" to "Images" We could also have a dedicated section, but I'm not clear how to call that.
Copy link
Copy Markdown
Member
|
this is probably easiest to review from the built docs, which aren't building |
Sorry, something went wrong.
iccir
approved these changes
Oct 8, 2026
iccir
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
I'm going to approve, but will defer to @story645 or others for merging.
This is basically a reordering; hence, sorting the lines of the previous rcsetup.py and new rcsetup.py should be identical. If we do so, and then run diff, we get:
[~/Desktop] diff old_rcsetup.py new_rcsetup.py
3441c3441
< _Param("boxplot.capprops.linewidth", 1.0, float, validate_float,
---
> _Param("boxplot.capprops.linewidth", 1.0, float, validate_float,
3492d3491
< _Section("AGG rendering"),
3505a3505
> _Section("Other"),
3513,3516c3513,3516
< _Subsection("Docstring parameters"),
< _Subsection("Mac OSX backend parameters"),
< _Subsection("PDF backend parameters"),
< _Subsection("PGF parameters"),
---
> _Subsection("AGG rendering"),
> _Subsection("Mac OSX backend"),
> _Subsection("PDF backend"),
> _Subsection("PGF backend"),
3518,3520c3518,3521
< _Subsection("PS backend parameters"),
< _Subsection("SVG backend parameters"),
< _Subsection("Tk backend parameters"),
---
> _Subsection("PS backend"),
> _Subsection("SVG backend"),
> _Subsection("Tk backend"),
> _Subsection("Webagg backend"),
A double space removed, and some renamed sections.
Sorry, something went wrong.
This branch has not been deployed
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
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
This reorders single entries and whole sections of the rcParams list so that sections are concise and there is a logical order to sections, roughly:
The full diff may be hard to review as it will not show the intent clearly. Therefore I've done every move as a separate commit. You may want to look at them one at a time, or just look at the final result. Note that we have unit tests in place that guarantee all parameters are in this list, so you don't have to worry / check whether something got lost.
Full list of changes:
77cf397 DOC: rcParams remove subsection Docstring parameters
f3103a8 DOC: rcParams move "pcolor.shading" and "pcolormesh.snap" from section "Lines" to "Images"
6fe4383 DOC: rcParams remove unneeded "... parameters" from all section titles
2219595 DOC: rcParams move "_internal.classic_mode" into section "Others"
bc8c83d DOC: rcParams move "backend" into section "Backends"
2b52954 DOC: rcParams move section "Paths" next to the other Artist-related sections ("Lines", "Patches", ...)
3bc622e DOC: rcParams make "AGG rendering" a subsection of "Backends"
ac6aec0 DOC: rcParams collect Figure, Axes, ... decorations sections at the top
d5752aa DOC: rcParams move section "Boxplot" next to the other plot sections
ea1d246 DOC: rcParams move "docstring.hardcopy" to section "Other"
8a2616d DOC: rcParams move section "Backend" to all backend subsections
82a4dc4 DOC: rcParams move webagg. to new section Webagg backend parameters - next to other backends
f704cac DOC: rcParams move axes3d.snap_rotation to section 3D Axes
2ee1ec3 DOC: rcParams move text.parse_math to section Mathtext and LaTeX
df1627b DOC: rcParams move figure.hooks to section Figure
5b8d5ca DOC: rcParams move timezone to section Other
We may merge or squash after review. I don't have a preference whether to keep the individual steps or not.
AI Disclosure
No AI.
PR quality check