Skip to content

Remove the last SkyCoord separation method references#15698

Merged
pllim merged 1 commit into
astropy:mainfrom
eerovaher:fix-docs-separation-ref
Dec 8, 2023
Merged

Remove the last SkyCoord separation method references#15698
pllim merged 1 commit into
astropy:mainfrom
eerovaher:fix-docs-separation-ref

Conversation

@eerovaher
Copy link
Copy Markdown
Member

@eerovaher eerovaher commented Dec 8, 2023

Description

The methods were removed in da730d0 because at runtime SkyCoord instances expose the equivalent methods of their underlying frames, but a handful of references in docstrings escaped detection and are currently breaking the documentation build on RTD.

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

@eerovaher
Remove SkyCoord separation methods references
611ad17 
The methods were removed in da730d0
because at runtime `SkyCoord` instances expose the equivalent methods of
their underlying frames, but a handful of references in docstrings
escaped detection.
@eerovaher eerovaher added this to the v6.1.0 milestone Dec 8, 2023
@eerovaher eerovaher requested a review from pllim December 8, 2023 16:20
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 8, 2023

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?
  • 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 reviewed Dec 8, 2023
View reviewed changes
Comment thread astropy/coordinates/sky_coordinate.py
--------
position_angle : inverse operation for the ``position_angle`` component
separation : inverse operation for the ``separation`` component
:meth:`~astropy.coordinates.BaseCoordinateFrame.separation` : inverse operation for the ``separation`` component
Copy link
Copy Markdown
Member

@pllim pllim Dec 8, 2023

Choose a reason for hiding this comment

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

See Also is a special numpydoc directive, not sure if you need the :meth: stuff here.

Copy link
Copy Markdown
Member

@pllim pllim Dec 8, 2023

Choose a reason for hiding this comment

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

Seems to render properly.

pllim
pllim approved these changes Dec 8, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@pllim pllim left a comment

Choose a reason for hiding this comment

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

RTD is green. Thanks for the quick fix!

Comment thread astropy/coordinates/sky_coordinate.py
--------
position_angle : inverse operation for the ``position_angle`` component
separation : inverse operation for the ``separation`` component
:meth:`~astropy.coordinates.BaseCoordinateFrame.separation` : inverse operation for the ``separation`` component
Copy link
Copy Markdown
Member

@pllim pllim Dec 8, 2023

Choose a reason for hiding this comment

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

Seems to render properly.

@pllim pllim merged commit 7c61eee into astropy:main Dec 8, 2023
@eerovaher eerovaher deleted the fix-docs-separation-ref branch December 8, 2023 19:29
@eerovaher eerovaher mentioned this pull request May 22, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pllim pllim pllim approved these changes

Assignees

No one assigned

Labels

coordinates Docs 🔥 Critical no-changelog-entry-needed

Projects

None yet

Milestone

v6.1.0

Development

Successfully merging this pull request may close these issues.

2 participants

@eerovaher @pllim