Skip to content

[Doc]: Documenting rcParam default values in kwargs table #25644

Open
@oscargus

Description

@oscargus

Documentation Link

https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes

Problem

There is a nice, automatically, generated kwargs section. However, it is not clear which values have defaults that are controlled by rcParams, nor what they are.

Suggested improvement

If I understand correctly, this is generated from the documentation of the corresponding set_* methods. An option may be to add a decorator, e.g. @rcparam('axes.facecolor') which adds a third column(?) (Default?) with the contents of :rc:....

(Naturally, not just for Axes.)

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