Skip to content
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.

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

[Doc]: List supported hatches and link to/embed hatch reference on hatches API page #27196

Open
story645 opened this issue Oct 25, 2023 · 10 comments · May be fixed by #27203 or #27370
Open

[Doc]: List supported hatches and link to/embed hatch reference on hatches API page #27196

story645 opened this issue Oct 25, 2023 · 10 comments · May be fixed by #27203 or #27370
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones! topic: hatch

Comments

@story645
Copy link
Member

Documentation Link

https://matplotlib.org/devdocs/api/hatch_api.html

Problem

The hatches API landing page is very sparse and I think some folks landing on this page are probably trying to find the list of supported hatches.

image

Suggested improvement

Minimally, I think the API reference should link/refer to the example gallery reference, but I also think maybe the first image from the gallery reference should be embedded at the top of the API reference page (via the .. plot:: path/to/image directive)
sphx_glr_hatch_style_reference_001

This is the file that would be changed in addressing this issue:

********************
``matplotlib.hatch``
********************
.. automodule:: matplotlib.hatch
:members:
:undoc-members:
:show-inheritance:

@story645 story645 added Documentation Good first issue Open a pull request against these issues if there are no active ones! topic: hatch labels Oct 25, 2023
@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.

@Ashhar-24
Copy link

Hey @story645 , I would love to work on this!
But I'm not able to understand how should I edit "matplotlib/doc/api/hatch_api.rst" file so that that API reference page will also show images of the hatches.
Kindly guide me through.
Thanks

@shivam200446
Copy link

I want to work on it assign me!

@story645
Copy link
Member Author

Sorry @shivam200446 we do not assign issues & there's already an opened pull request about this.

@story645 story645 linked a pull request Oct 26, 2023 that will close this issue
5 tasks
@ikigai27
Copy link

ikigai27 commented Nov 4, 2023

(plot:: path/to/image) appears to be used in documentation tools like Sphinx @story645

@story645
Copy link
Member Author

story645 commented Nov 4, 2023

@ikigai27 yes, our docs are built with sphinx. I'm not sure if you're asking a question or answering someone elses.

@ikigai27
Copy link

ikigai27 commented Nov 7, 2023

@story645 Permission to matplotlib denied to ikigai27. how to solve any guidance.

@story645
Copy link
Member Author

story645 commented Nov 7, 2023

What are you doing to get that error?

@ikigai27
Copy link

ikigai27 commented Nov 8, 2023

making PR it gives an error while pushing the changes to origin repository

@story645
Copy link
Member Author

story645 commented Nov 8, 2023

Did you follow our guide for making the changes on a feature branch on your own fork?

https://matplotlib.org/devdocs/devel/contribute.html#how-to-contribute

If not, I suggest you follow our instructions and then copy your changes over.

@pat8901 pat8901 linked a pull request Nov 26, 2023 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones! topic: hatch
Projects
None yet
4 participants