Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[Doc]: Documentation of rc parameters could be improved #23531

Open
@mwaskom

Description

@mwaskom

Documentation Link

https://matplotlib.org/stable/tutorials/introductory/customizing.html#the-default-matplotlibrc-file

Problem

As far as I am aware of, the only documentation of "what can be changed through rc paramters" is a the literal-included default matplotlibrc file, which has comments for various options. This is a very cumbersome way to present information in 2022.

There's also no direct link for third-party packages that expose an interface for setting rc parameters and want to link to the source documentation. You could hardcode the url including the anchor, but (1) that will break the next time matplotlib reorganizes things, and (2) if you link directly to the "default matplotlibrc file", there's no context for what people are looking at and it's confusing why the information is being presented the way that it is.

Suggested improvement

Rendering this information as regular html with semantic markup would be a significant improvement. Specific short-term benefits would include:

  • Visual differentiation of headers, parameters, defaults, and descriptions
  • Site navigation to various sections (it can be hard to find what you're looking for: the file is 767 lines long, and the groups are not in alphabetical order)

Additionally, this would make it possible to explore more complex interfaces, like having a filtering functionality to show all parameters with a given substring ("color") in their name.

To address the second issue, I would suggest separating the specific parameter documentation from the more general "how you customize matplotlib" page, with it discussion of variousmethods for changing those parameters (style sheets, matplotlibrc file, etc.).

I appreciate that the default matplotlibrc file is currently the source of truth for this information and that it's not properly structured in a way that would facilitate extracting the information, so this wouldn't be trivial. But I think it would help a lot.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


      [8]ページ先頭

      ©2009-2025 Movatter.jp