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

Fix the extract_along_coords() docstring for accuracy and clarity #6819

Merged
merged 1 commit into from
Mar 6, 2023

Conversation

ayshih
Copy link
Member

@ayshih ayshih commented Mar 3, 2023

This PR fixes the fact that the extract_along_coords() docstring doesn't explain accurately or clearly what it is doing. Most notably, it falsely claims that it extracts "every pixel the coordinate path intersects". See also #6815.

Fixes #6815

@ayshih ayshih added map Affects the map submodule DocFix labels Mar 3, 2023
@ayshih ayshih marked this pull request as ready for review March 5, 2023 04:52
@ayshih ayshih requested a review from a team as a code owner March 5, 2023 04:52
@wtbarnes wtbarnes merged commit bccad31 into sunpy:main Mar 6, 2023
@lumberbot-app
Copy link

lumberbot-app bot commented Mar 6, 2023

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout 4.0
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 bccad31049a3ab20fdacc630a3a6362808f182e1
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #6819: Fix the `extract_along_coords()` docstring for accuracy and clarity'
  1. Push to a named branch:
git push YOURFORK 4.0:auto-backport-of-pr-6819-on-4.0
  1. Create a PR against branch 4.0, I would have named this PR:

"Backport PR #6819 on branch 4.0 (Fix the extract_along_coords() docstring for accuracy and clarity)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@lumberbot-app lumberbot-app bot added the Still Needs Manual Backport This PR needs manually backporting label Mar 6, 2023
meeseeksmachine pushed a commit to meeseeksmachine/sunpy that referenced this pull request Mar 6, 2023
nabobalis pushed a commit that referenced this pull request Mar 6, 2023
…string for accuracy and clarity) (#6821)

Co-authored-by: Albert Y. Shih <ayshih@gmail.com>
@nabobalis nabobalis removed the Still Needs Manual Backport This PR needs manually backporting label Jul 18, 2023
@ayshih ayshih deleted the extract_docstring branch November 3, 2023 01:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
map Affects the map submodule No Changelog Entry Needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Explain why extract_along_coords returns coordinates
4 participants