NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

Added link and image to matplotlib.hatch API Page#27203

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

Ashhar-24 wants to merge1 commit intomatplotlib:mainfromAshhar-24:main

Closed

Added link and image to matplotlib.hatch API Page#27203

Ashhar-24 wants to merge1 commit intomatplotlib:mainfromAshhar-24:main

Conversation

Copy link

Ashhar-24 commentedOct 26, 2023•
edited
Loading

PR summary

PR checklist

"closes #0000" is in the body of the PR description tolink the related issue
new and changed code istested
Plotting related features are demonstrated in anexample
New Features andAPI Changes are noted with adirective and release note
Documentation complies withgeneral anddocstring guidelines

Added link and image to matplotli.hatch API Page

7e5f127

github-actionsbot reviewed

Oct 26, 2023

View reviewed changes

Copy link

github-actionsbot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join uson gitter for real-time discussion.

For details on testing, writing docs, and our review process, please seethe developer guide

We strive to be a welcoming and open project. Please follow ourCode of Conduct.

story645 linked an issue

Oct 26, 2023

that may beclosed by this pull request

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

Closed

story645 requested changes

Oct 26, 2023

View reviewed changes

Copy link

Member

story645 left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thank you for tackling this!
Please see our contributing guide for information on how to set up a development environment and how to build the docs as I think that may make it easier to implement the
solution proposed in the issue.
https://matplotlib.org/devdocs/devel/index.html#new-contributors

doc/api/hatch_api.rst


		.. _Click to see example gallery references: https://matplotlib.org/devdocs/gallery/shapes_and_collections/hatch_style_reference.html

		.. plot:: doc_static/hatch_preview_first.png

Copy link

Member

story645Oct 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

So you do not need to (and we prefer you don't) create the file. Sphinx gallery creates all the images when we build the docs & provides an image you can use here.

https://sphinx-gallery.github.io/stable/advanced.html#cross-referencing

One way to find the path you're looking for is to build the docs and look at the name of the resulting image.

doc/api/hatch_api.rst

		@@ -6,3 +6,7 @@
		:members:
		:undoc-members:
		:show-inheritance:

		.. _Click to see example gallery references: https://matplotlib.org/devdocs/gallery/shapes_and_collections/hatch_style_reference.html

Copy link

Member

story645Oct 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

We use cross-referencing because that forwards to the matching page for that version of the docs
https://sphinx-gallery.github.io/stable/advanced.html#cross-referencing

doc/api/hatch_api.rst

		@@ -6,3 +6,7 @@
		:members:
		:undoc-members:
		:show-inheritance:

Copy link

Member

story645Oct 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

The preamble being added in this PR should go above the sphinx directives b/c those directives populate the page w/ the function signature.

Copy link

Member

story645 commentedNov 5, 2023

Hey@Ashhar-24 do you plan to get back to this?

story645 self-assigned this

Nov 9, 2023

Copy link

Contributor

pat8901 commentedNov 23, 2023

@story645 Hello, I am new and looking to make my first pr. I am reading into this issue and I may be of some help. Right now I am gathering all necessary information on how to properly complete and test this issue. In the mean time I will keep an eye out for further developments!

Copy link

Member

story645 commentedNov 23, 2023

Ok, but also this is a pull request not an issue so@Ashhar-24 has done a lot of the work and what's left is to address the review comments. If@Ashhar-24 doesn't have the bandwidth to finish up, you're welcome to take over.

Copy link

Contributor

pat8901 commentedNov 23, 2023

@story645 My apologies, thank you for the clarification. Would it be appropriate to create a separate pr?
I did see in the issue the bot mentioned, "If there is an open PR, please collaborate on the work by reviewing it rather than duplicating it in a competing PR". I wanted to ask just for clarification.