FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Drop the out parameter cosmology's _cosmology_not_equal does not take by harshasiddartha · Pull Request #20214 · astropy/astropy · GitHub

/ astropy Public

Drop the out parameter cosmology's _cosmology_not_equal does not take - #20214

Open
harshasiddartha wants to merge 1 commit into
astropy:mainfrom
harshasiddartha:docs/drop-stale-out-param
ConversationCommits (1)ChecksFiles changed
Open

Drop the out parameter cosmology's _cosmology_not_equal does not take#20214
harshasiddartha wants to merge 1 commit into
astropy:mainfrom
harshasiddartha:docs/drop-stale-out-param

Conversation

harshasiddartha commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes #20208.

_cosmology_not_equal has the signature

def _cosmology_not_equal(cosmo1: Any, cosmo2: Any, /, *, allow_equivalent: bool = False) -> bool:

and documents an out parameter, described as "a location into which the result is stored", which is not accepted here or anywhere along the _comparison_decorator path — the wrapper forwards **kwargs to the wrapped function, which would raise on out.

format in the same section stays: it is not in the signature either, but _comparison_decorator consumes it and its own Notes say every decorated function should document it. out has no such counterpart, and cosmology_equal directly above — same decorator, same signature — has never carried the entry.

Docstring only — no signature, call site, or behaviour is touched.

Changelog

Not added: docstring only, and the function is private, so nothing user-visible changes. Per CONTRIBUTING.md, minor documentation updates do not need a fragment. Happy to add one or take the no-changelog-entry-needed label if you prefer.

Drop the out parameter _cosmology_not_equal does not take
9c43063 
The signature is (cosmo1, cosmo2, /, *, allow_equivalent). No out argument is
accepted there or anywhere along the _comparison_decorator path, and
cosmology_equal, which has the same structure, carries no such entry. [ci skip]
harshasiddartha requested a review from a team as a code owner August 5, 2026 21:55

github-actions Bot commented Aug 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.

nstarman moved this from Triage to In Progress in Cosmology, the Expansion Aug 6, 2026
github-project-automation Bot moved this from In Progress to Reviewer approved in Cosmology, the Expansion Aug 6, 2026

nstarman commented Aug 6, 2026

Copy link
Copy Markdown
Member

Hm. The CI isn't running. 🤔

pllim reviewed Aug 6, 2026
View reviewed changes
Comment thread astropy/cosmology/_src/funcs/comparison.py
shape that the inputs broadcast to. If not provided or None, a
freshly-allocated array is returned.

format : bool or None or str or tuple thereof, optional keyword-only

pllim Aug 6, 2026

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@nstarman what about this one?

nstarman Aug 6, 2026

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

which one? format ?

pllim Aug 6, 2026

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Yes, format is mentioned but not in signature. Is that expected?

nstarman Aug 6, 2026

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

hm. Nor in cosmology_equal. Those were clearly intended plans, but I don't recollect the details.

pllim Aug 6, 2026

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Might as well address that also in this PR?

pllim added this to the v7.2.3 milestone Aug 6, 2026
pllim added Bug backport-v7.2.x on-merge: backport to v7.2.x backport-v8.0.x on-merge: backport to v8.0.x Docs labels Aug 6, 2026
nstarman self-requested a review August 7, 2026 17:37
nstarman moved this from Reviewer approved to Review in progress in Cosmology, the Expansion Aug 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

pllim pllim left review comments
nstarman Awaiting requested review from nstarman

Assignees

No one assigned

Labels

backport-v7.2.x on-merge: backport to v7.2.x backport-v8.0.x on-merge: backport to v8.0.x Bug cosmology Docs no-changelog-entry-needed

Projects

Cosmology, the Expansion
Status: Review in progress

Milestone

v7.2.3

Development

Successfully merging this pull request may close these issues.

_cosmology_not_equal documents an out parameter it does not take

3 participants

Back | FazBrowse Home | New Git URL