Skip to content

[Doc]: Stackplot hatch functionality has version dependencies #28533

Closed

Description

@RHammond2

Documentation Link

https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.stackplot.html

Problem

The documentation for matplotlib.pyplot.stackplot() should indicate that matplotlib version 3.9.x or greater supports hatch being a list. In version 3.8.3 I was getting errors when passing a list of hatch symbols, regardless of the simplicity or complexity of the example.

If it's easier I can revisit this once I complete the body of work where this became an issue and I can submit a PR to update the documentation myself, just let me know.

Suggested improvement

No response

Activity

  1. story645 commented on Jul 9, 2024

    @story645
    Member

    Sorry about missing that in review, yes if you don't mind adding a version added directive that'd be great!

    https://matplotlib.org/devdocs/devel/api_changes.html#announce-new-and-deprecated-api

  2. timhoffm commented on Jul 11, 2024

    @timhoffm
    Member

    Also the documented type is wrong:

    image

    It should be

    hatch : str or list of str, optional
    

    and include in the explanation that a single str applies the same hatch to all datasets.

  3. added
    🌱 Good first issueOpen a pull request against these issues if there are no active ones!
    on Jul 11, 2024
  4. github-actions commented on Jul 11, 2024

    @github-actions

    Good first issue - notes for new contributors

    This issue is suited to new contributors because it does not require understanding of the
    Matplotlib internals. To get started, please see our contributing
    guide
    .

    We do not assign issues. Check the Development section in the sidebar for linked pull
    requests (PRs). If there are none, feel free to start working on it. If there is an open PR, please
    collaborate on the work by reviewing it rather than duplicating it in a competing PR.

    If something is unclear, please reach out on any of our communication
    channels
    .

  5. added
    Difficulty: Easyhttps://matplotlib.org/devdocs/devel/contribute.html#good-first-issues
    on Jul 13, 2024
  6. added this to the v3.9.2 milestone on Jul 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Difficulty: Easyhttps://matplotlib.org/devdocs/devel/contribute.html#good-first-issuesDocumentation🌱 Good first issueOpen a pull request against these issues if there are no active ones!

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions