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

Convert draw rectangle gallery example into a how-to guide #7435

Merged
merged 8 commits into from Mar 26, 2024

Conversation

NucleonGodX
Copy link
Contributor

addresses #7082

@nabobalis nabobalis added the Documentation Affects the documentation label Feb 3, 2024
changelog/7435.doc.rst Outdated Show resolved Hide resolved
@nabobalis
Copy link
Contributor

Thanks for the PR @NucleonGodX, I added some suggestions that hopefully won't break.

>>> import sunpy.data.sample
>>> import sunpy.map

>>> aia_map = sunpy.map.Map(sunpy.data.sample.AIA_171_IMAGE)
Copy link
Contributor

Choose a reason for hiding this comment

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

This needs to be marked remote-data

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@NucleonGodX NucleonGodX requested a review from a team as a code owner February 6, 2024 20:16
@NucleonGodX
Copy link
Contributor Author

pre-commit.ci autofix

@nabobalis
Copy link
Contributor

Looks like we need to deal with:

Ignoring reference in hoverxref_ignore_refs. target=search
<unknown>:1063: WARNING: undefined label: 'sphx_glr_generated_gallery_plotting_plot_rectangle.py'

@nabobalis nabobalis marked this pull request as draft February 7, 2024 18:12
@NucleonGodX
Copy link
Contributor Author

I'm actually busy with some exams right now, I'll work on this pr in like 10-12 days from now!

@nabobalis
Copy link
Contributor

nabobalis commented Feb 12, 2024

I'm actually busy with some exams right now, I'll work on this pr in like 10-12 days from now!

That is perfectly fine, exams are more important.

@nabobalis nabobalis marked this pull request as ready for review March 21, 2024 02:49
@nabobalis nabobalis added the No Backport A PR that isn't to be backported to any release branch. (To be used as a flag to other maintainers) label Mar 21, 2024
@nabobalis nabobalis added the Needs Review Needs reviews before merge label Mar 21, 2024
@wtbarnes
Copy link
Member

I'm going to be annoying and suggest that, even though it's more boring, we should be drawing the same rectangle in each case. The point of this how to guide is to show multiple ways of doing the same thing. By changing the coordinates of the corners, we're not clearly illustrating that these different approaches lead to the same outcome.

@nabobalis nabobalis removed the Needs Review Needs reviews before merge label Mar 26, 2024
@nabobalis nabobalis merged commit 736f875 into sunpy:main Mar 26, 2024
27 of 28 checks passed
@nabobalis
Copy link
Contributor

Thanks again @NucleonGodX for the PR.

@NucleonGodX
Copy link
Contributor Author

Thanks @nabobalis for your assistance in this pull request!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Affects the documentation No Backport A PR that isn't to be backported to any release branch. (To be used as a flag to other maintainers)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants