You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
_cosmology_not_equal documents an out parameter it does not take #20208
The signature takes only cosmo1, cosmo2 and allow_equivalent. format in the same docstring is legitimate — _comparison_decorator states in its own Notes that every decorated function should document it — but out is not mentioned there and is not accepted anywhere along that path. The wording reads like it was lifted from a numpy ufunc docstring.
cosmology_equal right above it has the same structure and does not carry an out entry, which suggests this one is simply stale rather than describing something intended.
The function is private, so nothing user-facing depends on it; removing the entry looks safe, but since it is your call whether out was planned, I left it out of #20205. Happy to send a one-line PR removing it.
Found with a static checker comparing numpydoc parameter names against the signature below them; each finding was read by hand.
Since this issue was opened, we have introduced numpydoc validation. I feel like this will naturally be addressed when @nstarman decides to comb through the numpydoc violations, so closing to avoid AI PR spam.
Activity
pllim commentedon Aug 5, 2026
@nstarman , could you please advise? Thanks!
nstarman commentedon Aug 6, 2026
I think removing it is a good fix. If
outsupport is ever needed we can try to add it then. Thanks!DOC: remove spurious out parameter from _cosmology_not_equal docstring (
pllim commentedon Nov 2, 2026
Since this issue was opened, we have introduced numpydoc validation. I feel like this will naturally be addressed when @nstarman decides to comb through the numpydoc violations, so closing to avoid AI PR spam.
nstarman commentedon Nov 7, 2026
Thanks @darkdi for bringing this to our attention. I think #20774 now covers this class of error.