Skip to content

DOC: User's Guide needs section for contouring and pcolor-like plots #7116

Closed as duplicate

Description

@efiring

This is prompted by #7103, but the documentation gap has been obvious for many years.

Activity

  1. added this to the milestone on Sep 15, 2016
  2. modified the milestones: , on Oct 3, 2017
  3. soma2000-lang commented on Jan 27, 2022

    @soma2000-lang

    @efiring Can I work on this??

  4. efiring commented on Jan 27, 2022

    @efiring
    MemberAuthor

    Certainly! The structure and content of the docs have changed quite a bit since I opened this issue (which I completely forgot about). I suggest that you start with a rough outline to specify the information you would like to add, and what section or sections it would go in, given the current structure of the docs. I'm guessing it would mainly be in one or more tutorials.

  5. github-actions commented on Nov 3, 2023

    @github-actions

    This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help!

  6. added
    keepItems to be ignored by the “Stale” Github Action
    and removed
    status: inactiveMarked by the “Stale” Github Action
    on Nov 3, 2023
  7. jklymak commented on Nov 3, 2023

    @jklymak
    Member

    I think this is still a gap. Of course we have added plot types, a section to the Quick Start Guide, and the Axes documentation has sections for contour and 2d arrays.

    I think the User Guide could have a major section, between "Axes" and "Artists" that has the main visualization types broken out and introduced relatively carefully. Probably should follow a similar order to the Axes API reference.

  8. story645 commented on Nov 3, 2023

    @story645
    Member

    Probably should follow a similar order to the Axes API reference.

    I'd suggest the plot types gallery ordering b/c then we could link to each of those sections as the see also.

  9. sahil-11116 commented on Jul 23, 2026

    @sahil-11116

    Hi I'm a new contributor to Matplotlib and would like to take this documentation issue. I'd appreciate any guidance or suggestions on where to begin. Thank you.

  10. timhoffm commented on Jul 23, 2026

    @timhoffm
    Member

    @sahil-11116 thanks for your interest. Discussion on the topic has moved on meanwhile. This is a special case of the larger topic on how to present and teach plotting functions in the user guide, which is discussed in detail in #31496 and #29124.

    I claim that the linked issue and PR cover this issue and therefore close here.

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

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions