Skip to content

MNT: Run PTH flake test in prep for supporting pathlib (visualization)#16935

Merged
pllim merged 1 commit intoastropy:mainfrom
neutrinoceros:visualization/mnt/pth_checks
Oct 10, 2024
Merged

MNT: Run PTH flake test in prep for supporting pathlib (visualization)#16935
pllim merged 1 commit intoastropy:mainfrom
neutrinoceros:visualization/mnt/pth_checks

Conversation

@neutrinoceros
Copy link
Contributor

Description

Extracted from #16060. Ref #16924

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2024

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 instructions for rebase and squash.
  • 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?
  • 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.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2024

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

Copy link
Member

Choose a reason for hiding this comment

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

Not sure what this script is for, so I'll let subpackage maintainer decide if supporting Path here needs a change log or not. Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

I think we should probably just have a single changelog entry in 'other' which mentions that a number of functions now support Path, rather than fully enumerating all the functions that now support it.

Copy link
Member

@astrofrog astrofrog left a comment

Choose a reason for hiding this comment

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

Looks good to me though note the failure due to the missing changelog. I don't mind if we include one changelog entry per PR or if we mark them all as not needing one then add a single changelog entry later that says that many/all functions in astropy that accept filenames now accept paths.

@astrofrog
Copy link
Member

Actually maybe worth just adding a changelog entry, it might not be that many functions in the end. Certainly it's not for this sub-package.

@neutrinoceros
Copy link
Contributor Author

I'm confused: I didn't think the affected function was meant to be public ? I do see a @deprecated_renamed_argument decorator on it but it's never used directly and only documented as a command line script. Am I mistaken ?

@pllim
Copy link
Member

pllim commented Oct 10, 2024

Yeah I don't think we ship the scripts as "public API"? Merging. Thanks!

@pllim pllim merged commit 6b1cb88 into astropy:main Oct 10, 2024
@neutrinoceros neutrinoceros deleted the visualization/mnt/pth_checks branch October 10, 2024 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants