Skip to content

Update WCSAxes.grid() API to match Matplotlib's signature - #20784

Merged
pllim merged 2 commits into
astropy:mainfrom
astrofrog:wcsaxes-fix-15987
Nov 7, 2026
Merged

pllim merged 2 commits into
astropy:mainfrom
astrofrog:wcsaxes-fix-15987

Conversation

@astrofrog

@astrofrog astrofrog commented Nov 5, 2026 •

Copy link
Copy Markdown
Member

Description

This fixes #15987 by deprecating the b= keyword argument and renaming it to visible=

Since this introduces a deprecation, I don't think we should backport

AI Disclosure

If AI tools were used to develop this pull request, describe the tools including specific model and version, how they were used, and what content is AI generated. Otherwise enter "N/A".

Assisted by Opus 5.5

  • I certify that I am human and that I take full responsibility for this pull request including all interactions with reviewers.

Merge method

  • 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.

…lib parent class and stop CoordinateHelper.grid from silently overriding a visible keyword
@github-actions

github-actions Bot commented Nov 5, 2026

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.

@astrofrog
astrofrog requested a review from Cadair November 5, 2026 12:02
Comment thread astropy/visualization/wcsaxes/core.py Resolved

@pllim pllim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks reasonable but I'll give others a chance to review. Thanks!

@pllim pllim added the API change PRs and issues that change an existing API, possibly requiring a deprecation period label Nov 5, 2026
@pllim

pllim commented Nov 5, 2026

Copy link
Copy Markdown
Member

I pre-emptively opened #20788 as follow-up. If the situation change here, please also update that issue accordingly. Thanks!

@pllim
pllim merged commit 5666012 into astropy:main Nov 7, 2026
51 of 54 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

API change PRs and issues that change an existing API, possibly requiring a deprecation period visualization.wcsaxes visualization

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: WCSAxes.grid's signature is incompatible with parent class

3 participants