Skip to content

TST: follow numpy/pytest traceback conventions in assert_quantity_allclose test helper function - #16069

Closed
neutrinoceros wants to merge 1 commit into
astropy:mainfrom
neutrinoceros:tests/helpers/traceback_convetions
Closed

neutrinoceros wants to merge 1 commit into
astropy:mainfrom
neutrinoceros:tests/helpers/traceback_convetions

Conversation

@neutrinoceros

Copy link
Copy Markdown
Contributor

Description

Conventionally, numpy.testing.assert_* functions are hidden in pytest tracebacks.
I noticed that this helper function wasn't, despite being evidently inspired from numpy.testing.

  • 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
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 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
Copy Markdown
Contributor

👋 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?

@neutrinoceros

Copy link
Copy Markdown
Contributor Author

Actually I opened this a bit early. There are way more assert_* helper functions than just this one and it's not obvious that they should all adopt this convention. I'll close this to reduce noise levels, and maybe I'll open a proper issue later.

@neutrinoceros
neutrinoceros deleted the tests/helpers/traceback_convetions branch February 19, 2024 15:17
@pllim pllim added this to the v6.1.0 milestone Feb 19, 2024
@pllim

pllim commented Feb 19, 2024

Copy link
Copy Markdown
Member

xref #16071

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants