Drop the out parameter cosmology's _cosmology_not_equal does not take - #20214
Open
harshasiddartha wants to merge 1 commit into
Open
Drop the out parameter cosmology's _cosmology_not_equal does not take#20214harshasiddartha wants to merge 1 commit into
harshasiddartha wants to merge 1 commit into
Conversation
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]
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.
|
nstarman
approved these changes
Aug 6, 2026
Member
|
Hm. The CI isn't running. 🤔 |
pllim
reviewed
Aug 6, 2026
| 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 |
Member
There was a problem hiding this comment.
Yes, format is mentioned but not in signature. Is that expected?
Member
There was a problem hiding this comment.
hm. Nor in cosmology_equal. Those were clearly intended plans, but I don't recollect the details.
Member
There was a problem hiding this comment.
Might as well address that also in this PR?
nstarman
self-requested a review
August 7, 2026 17:37
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #20208.
_cosmology_not_equalhas the signatureand documents an
outparameter, described as "a location into which the result is stored", which is not accepted here or anywhere along the_comparison_decoratorpath — the wrapper forwards**kwargsto the wrapped function, which would raise onout.formatin the same section stays: it is not in the signature either, but_comparison_decoratorconsumes it and its own Notes say every decorated function should document it.outhas no such counterpart, andcosmology_equaldirectly 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 theno-changelog-entry-neededlabel if you prefer.