Skip to content

[Doc]: regression in stable/api/index #26623

Description

@jklymak

Documentation Link

https://matplotlib.org/stable/api/index versus https://matplotlib.org/devdocs/api/index.html

Problem

There was some cleanup of https://matplotlib.org/devdocs/api/index.html by @timhoffm in #26402, but I feel it went too far. For instance, there used to be a small plot on the API page to orient users as to the basic usage pattern. I find the current version very terse, and not helpful to new users. You can argue that an API page should be terse, however our API is actually pretty strange and subject to confusion, so I think getting users on the right path here is helpful.

Suggested improvement

  • should at least include the small example again
  • be a bit more verbose about the two APIs.
  • include subplot_mosaic on the same level as subplots.

Activity

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

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions