Cosmo rename arg for io - #14780

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 "When to rebase and squash commits".
• 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.

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

but found the large number of unrelated code and docstring changes distracting

I did a drive-by glance but gave up for the same reason too. It was unclear to me why these are necessary for the renaming process.

Overall, I like the idea but found the large number of unrelated code and docstring changes distracting and ended up running out of time.

Apologies for the constellation of changes surrounding the main portion of the PR. These changes arose because when I added the docstring for the new argument I wanted to make sure I got the format correct, following numpydoc to the T. I found that the docstring was incorrectly implemented 😲 and rather than mixing styles within one docstring, I fixed the relevant docstrings.

@mhvk wrote:

...don't we have something like this already in the general IO? I tried looking and couldn't find it, so probably not, but let me ping @taldcroft regardless, since perhaps this option to rename things would be something we should support more generally.

I also think renaming things at the astropy.io level could be useful. For example, I would find it convenient if I could work in Python with a Table with columns named "ra" and "dec", but when I write a LaTeX file using astropy.io I might want the column names to appear as "$\alpha$" and "$\delta$". So if there is a way of implementing renaming things so that both astropy.table and astropy.cosmology would benefit then that should be considered. I am not familiar enough with astropy.io to know if this would be simple to achieve or not, so it would be good to know what @taldcroft thinks.

@eerovaher, I agree, but m any of the Cosmology I/O methods do not rely on Table, so lacking prior art from table, I think this PR is a good place to start.

Thanks @eerovaher for the detailed review!

I squashed commits, added and modified tests, added to the Examples in the docstring, and put in a "whatsnew".

Yikes, but failures are unrelated.

numpy 1.25 is released but h5py didn't catch up. Annoying...

The deprecation warnings caused by h5py have been dealt with on main, so I suggest rebasing to allow all the CI tests to succeed.

I'd like to merge, but the change log entry CI check is stuck. @pllim, what's the best way to proceed?

Best way was probably what you did. I merged it. 😉

Sigh, if only there is a better way to run change log check... it gets stuck more and more often now.

Thanks, all!

I usually just turn labels on and off so it runs again (and nothing else does), but it is indeed a bit of a pain.

The problem here is we rely on Actions, so it competes with other jobs and sometimes GitHub might flag it as spammy.