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/image directive)
This is the file that would be changed in addressing this issue:
|
******************** |
|
``matplotlib.hatch`` |
|
******************** |
|
|
|
.. automodule:: matplotlib.hatch |
|
:members: |
|
:undoc-members: |
|
:show-inheritance: |
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