Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
RHammond2 opened this issue Jul 9, 2024 · 3 comments · Fixed by #28571
Closed

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

RHammond2 opened this issue Jul 9, 2024 · 3 comments · Fixed by #28571
Labels
Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation Good first issue Open a pull request against these issues if there are no active ones!
Milestone
v3.9.2

Comments

@RHammond2
Copy link

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
@story645
Copy link
Member

story645 commented Jul 9, 2024

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

@story645 story645 mentioned this issue Jul 9, 2024
Merged
2 tasks
@timhoffm
Copy link
Member

timhoffm commented Jul 11, 2024 •
edited
Loading

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.

@timhoffm timhoffm added the Good first issue Open a pull request against these issues if there are no active ones! label Jul 11, 2024
@github-actions GitHub Actions
Copy link

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.

@QuLogic QuLogic added the Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues label Jul 13, 2024
@FilBalza FilBalza mentioned this issue Jul 13, 2024
Merged
3 tasks
@QuLogic QuLogic added this to the v3.9.2 milestone Jul 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation Good first issue Open a pull request against these issues if there are no active ones!
Projects
None yet
Milestone
v3.9.2
Development

Successfully merging a pull request may close this issue.

DOC: Add version directive to hatch parameter in stackplot FilBalza/matplotlib
4 participants
@QuLogic @story645 @timhoffm @RHammond2