Skip to content

[Doc]: Better document Axes.transData and other transXYZ attributes #25220

Open
@timhoffm

Description

@timhoffm

Documentation Link

No response

Problem

It's documented in the tutorial https://matplotlib.org/stable/tutorials/advanced/transforms_tutorial.html#data-coordinates, but not very discoverable:

Problem: transData and the likes are only attributes set in a [private function]/(

self.transData = self.transScale + (self.transLimits + self.transAxes)
)
As such, they do not have a docstring and do not appear in the API documentation.

Suggested improvement

Action: Find out, how to make this available in the API docs at https://github.com/matplotlib/matplotlib/blob/main/doc/api/axes_api.rst

Worth checking:

Alternative: Turn the trans* attributes into properties. They can be documented properly and have the advantage of being read-only. This is a slight performance cost, but should be negligible compared to any action involving the transforms.

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