Skip to content

TYP: add inline type annotations around internal equivalency tuples and converters#20105

Draft
neutrinoceros wants to merge 1 commit into
astropy:mainfrom
neutrinoceros:units/typ/equivalencies-and-converters
Draft

TYP: add inline type annotations around internal equivalency tuples and converters#20105
neutrinoceros wants to merge 1 commit into
astropy:mainfrom
neutrinoceros:units/typ/equivalencies-and-converters

Conversation

@neutrinoceros

@neutrinoceros neutrinoceros commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Description

As a by product of reviewing #19821, I'm adding annotations to clarify what these functions do, for the non-experts (myself included).

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

@neutrinoceros neutrinoceros added this to the v8.1.0 milestone Jul 21, 2026
@neutrinoceros neutrinoceros added units typing related to type annotations labels Jul 21, 2026
@github-actions

github-actions Bot commented Jul 21, 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.

neutrinoceros
neutrinoceros commented Jul 21, 2026
View reviewed changes
Comment thread astropy/units/core.py


_T = TypeVar("_T")
_Transform: TypeAlias = Callable[[_T], _T] # TODO: should this be _ScaleConverter ?

@neutrinoceros neutrinoceros Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

this comment is really a question to reviewers. I think that this type should really be _ScaleConverter, but it's not exactly consistent with how it's used in practice. Maybe there's something I'm not understanding, or maybe this is really a subtle bug being uncovered.

@neutrinoceros
neutrinoceros force-pushed the units/typ/equivalencies-and-converters branch from f0761ce to 1030892 Compare July 21, 2026 16:16
@neutrinoceros
neutrinoceros force-pushed the units/typ/equivalencies-and-converters branch from 1030892 to 81a9510 Compare July 21, 2026 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

no-changelog-entry-needed typing related to type annotations units

Projects

None yet

Milestone

v8.1.0

Development

Successfully merging this pull request may close these issues.

1 participant

@neutrinoceros