Skip to content

Cosmo io docs - #15090

Merged
nstarman merged 1 commit into
astropy:mainfrom
nstarman:cosmo-io-docs
Aug 2, 2023
Merged

Cosmo io docs#15090
nstarman merged 1 commit into
astropy:mainfrom
nstarman:cosmo-io-docs

Conversation

@nstarman

@nstarman nstarman commented Jul 25, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Refactor the cosmology I/O docs: see https://astropy--15090.org.readthedocs.build/en/15090/cosmology/io/index.html#cosmology-io

  • showcase all the I/O formats.
  • clearer layout

First #15088, then this Done.

@nstarman nstarman added this to the v6.0 milestone Jul 25, 2023
@github-actions

github-actions Bot commented Jul 25, 2023 •
edited by taldcroft
Loading

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

@github-actions

github-actions Bot commented Jul 25, 2023

Copy link
Copy Markdown
Contributor

👋 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?

@nstarman
nstarman force-pushed the cosmo-io-docs branch 7 times, most recently from 6511024 to 2a0002d Compare July 30, 2023 20:39
@nstarman nstarman mentioned this pull request Jul 30, 2023
Closed
3 tasks done
@nstarman nstarman mentioned this pull request Aug 1, 2023
Merged
@nstarman
nstarman force-pushed the cosmo-io-docs branch 2 times, most recently from 0f0c754 to a5340c5 Compare August 1, 2023 20:18
@nstarman
nstarman marked this pull request as ready for review August 1, 2023 20:27
@nstarman
nstarman requested a review from a team as a code owner August 1, 2023 20:27
@nstarman
nstarman requested a review from taldcroft August 1, 2023 20:27
nstarman
nstarman commented Aug 1, 2023
View reviewed changes
Comment thread docs/cosmology/io/index.rst
----------- ---- ----- -------------
ascii.ecsv Yes Yes Yes
ascii.html Yes Yes Yes
ascii.latex No Yes Yes

@nstarman nstarman Aug 1, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@taldcroft, Adding the Write table includes ascii.latex. The asymmetry between the read/write.list_formats() might be something to fix in io.registry.

@taldcroft taldcroft Aug 2, 2023

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.

I'm not sure exactly what you mean. In both cases the list_formats() method includes a row or each available format for read or write.

@nstarman nstarman Aug 2, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Since ascii.latex isn't registered with read it doesn't show up in read.list_formats(). That seems sensible, except that read.list_formats() also has a column for write! It's very confusing that the output of read.list_formats() and write.list_formats() would be different if they have columns for each other.

taldcroft
taldcroft reviewed Aug 2, 2023
View reviewed changes
Comment thread docs/cosmology/io/index.rst Outdated
.. _cosmology_io:

*********************
Cosmology I/O/Convert

@taldcroft taldcroft Aug 2, 2023

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.

This looks a little odd. Was it supposed to be something like Cosmology I/O and Convert?

@nstarman nstarman Aug 2, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I could go either way. I/O is common parlance, but I want to distinguish reading and writing from live-object conversion, like the Cosmology -> Mapping so I added /Convert to the standard abbreviation.

@nstarman nstarman Aug 2, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Changed!

taldcroft
taldcroft approved these changes Aug 2, 2023
View reviewed changes

@taldcroft taldcroft left a comment

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.

@nstarman - I won't say that I read through all of the new docs in detail, but I skimmed the whole thing and confirmed that the rendered outputs provide extremely comprehensive documentation of the cosmology I/O and conversion functionality. There is one typo you probably want to fix but otherwise fantastic!

@nstarman
nstarman enabled auto-merge August 2, 2023 19:47
@nstarman
nstarman merged commit a79501c into astropy:main Aug 2, 2023
@pllim

pllim commented Aug 2, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Did this pre-date the new theme? Because the TOC looks weird now. I will open new issue (#15117).

@pllim pllim mentioned this pull request Aug 2, 2023
Closed
@nstarman
nstarman deleted the cosmo-io-docs branch August 2, 2023 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@taldcroft taldcroft taldcroft approved these changes

Assignees

No one assigned

Labels

cosmology no-changelog-entry-needed

Projects

Cosmology, the Expansion
Status: Done

Milestone

v6.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@nstarman @pllim @taldcroft