Skip to content

DOC: Add instructions on how to workaround PR 14439 downstream - #14526

Merged
pllim merged 2 commits into
astropy:mainfrom
pllim:clarify-pr14439-whats-new
Mar 14, 2023
Merged

DOC: Add instructions on how to workaround PR 14439 downstream#14526
pllim merged 2 commits into
astropy:mainfrom
pllim:clarify-pr14439-whats-new

Conversation

@pllim

@pllim pllim commented Mar 14, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Description

This pull request is to give people some ideas if they are affected by #14439 downstream. If you have better ideas, please leave suggestions. If not, please approve. Thanks!

My examples are based on my own workarounds here:

@pllim pllim added Docs units Affects-dev PRs and issues that do not impact an existing Astropy release skip-changelog-checks Tells bot to skip changlog checks labels Mar 14, 2023
@pllim pllim added this to the v5.3 milestone Mar 14, 2023
@pllim
pllim requested a review from mhvk March 14, 2023 12:50
@github-actions

github-actions Bot commented Mar 14, 2023 •
edited by pllim
Loading

Copy link
Copy Markdown
Contributor

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see "When to rebase and squash commits".
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • Is a milestone set? Milestone must be set but we cannot check for it on Actions; do not let the green checkmark fool you.
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

@pllim pllim mentioned this pull request Mar 14, 2023
Merged
mhvk
mhvk approved these changes Mar 14, 2023
View reviewed changes

@mhvk mhvk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks!!

I think it would be good to have at least one example be the other way around, i.e., assume that one has already changed the strings to match the new version. Minimal suggestion inline -- would be fine to also change the module example.

Approving since this is really a minor detail.

Comment thread docs/whatsnew/5.3.rst Resolved
@pllim @mhvk
Change one example to use new ordering
cf70685 
Co-authored-by: Marten van Kerkwijk <[email protected]>
@mhvk

mhvk commented Mar 14, 2023

Copy link
Copy Markdown
Contributor

There's a SAMP error holding this up... Otherwise ready to go in, I think.

@pllim

pllim commented Mar 14, 2023

Copy link
Copy Markdown
Member Author

Failure is unrelated. I'll merge since you approved. Thanks, @mhvk !

@pllim
pllim merged commit 1b41891 into astropy:main Mar 14, 2023
@pllim
pllim deleted the clarify-pr14439-whats-new branch March 14, 2023 16:01
@mhvk mhvk mentioned this pull request Mar 17, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mhvk mhvk mhvk approved these changes

Assignees

No one assigned

Labels

Affects-dev PRs and issues that do not impact an existing Astropy release Docs skip-changelog-checks Tells bot to skip changlog checks units

Projects

None yet

Milestone

v5.3

Development

Successfully merging this pull request may close these issues.

2 participants

@pllim @mhvk