[Doc]: List supported hatches and link to/embed hatch reference on hatches API page #27196
Comments
Good first issue - notes for new contributorsThis 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. |
|
Hey @story645 , I would love to work on this! |
|
I want to work on it assign me! |
|
Sorry @shivam200446 we do not assign issues & there's already an opened pull request about this. |
|
(plot:: path/to/image) appears to be used in documentation tools like Sphinx @story645 |
|
@ikigai27 yes, our docs are built with sphinx. I'm not sure if you're asking a question or answering someone elses. |
|
@story645 Permission to matplotlib denied to ikigai27. how to solve any guidance. |
|
What are you doing to get that error? |
|
making PR it gives an error while pushing the changes to origin repository |
|
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. |
|
Also should add an |
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.
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/imagedirective)This is the file that would be changed in addressing this issue:
matplotlib/doc/api/hatch_api.rst
Lines 1 to 8 in 879cf76
The text was updated successfully, but these errors were encountered: