Skip to content

[Doc]: Document setters and getters from private superclasses #26478

Open
@oscargus

Description

@oscargus

Documentation Link

https://matplotlib.org/devdocs/api/image_api.html#matplotlib.image.AxesImage.set

Problem

The above is one example, but there are some cases where the superclass is common and therefore the corresponding setters and getters are not documented. For images, it is alpha, array, data, filternorm, filterrad, interpolation, interpolation_stage, and resample that has getters and setters with doc-strings, but since _ImageBase is private they are not shown.

Also, other common methods as can_composite, get_size, get_shape, and write_png are shown in the documentation.

Suggested improvement

Figure out how to add these in a good way. There are probably more classes where this happens.

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