Skip to content

[Doc]: object description for "spines"of matplot.axes.Axes not found #29964

Closed

Description

@mai0503

Documentation Link

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

Problem

I found the documentation of object "spines" of matplot.axes.Axes not clear enough. On the homepage of matplot.axes.Axes there is no link to this description.

Suggested improvement

No response

Activity

  1. rcomer commented on Apr 25, 2025

    @rcomer
    Member

    If it were to link, it would link here: https://matplotlib.org/stable/api/spines_api.html#matplotlib.spines.Spines

    axes.spines is an attribute added in instantiation, so I do not think we can hang a docstring off it as-is. Perhaps it should instead be a property?

    self.spines = mspines.Spines.from_dict(self._gen_axes_spines())

  2. timhoffm commented on Apr 25, 2025

    @timhoffm
    Member

    Property oder type annotation works. Both variants are used in https://github.com/matplotlib/matplotlib/pull/28825/files.

  3. added this to the v3.10.2 milestone on Apr 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions