Skip to content

Cosmo latex identify and cleanup - #15088

Merged
nstarman merged 2 commits into
astropy:mainfrom
nstarman:cosmo-latex-identify
Aug 1, 2023
Merged

nstarman merged 2 commits into
astropy:mainfrom
nstarman:cosmo-latex-identify

Conversation

@nstarman

@nstarman nstarman commented Jul 25, 2023 •

Copy link
Copy Markdown
Member
  • Add autoidentification
  • docstrings
  • unregister 'latex' in favor of 'ascii.latex' (this is a new format that isn't yet in any released version)
  • small cleanup

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

github-actions Bot commented Jul 25, 2023 •

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

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-latex-identify branch 2 times, most recently from 05bf8eb to 7afee6b Compare July 25, 2023 05:20
@nstarman
nstarman force-pushed the cosmo-latex-identify branch 2 times, most recently from d35c48a to ddf2c5d Compare July 25, 2023 14:02
@nstarman
nstarman marked this pull request as ready for review July 25, 2023 17:04
@nstarman
nstarman requested a review from a team as a code owner July 25, 2023 17:04
@nstarman
nstarman requested a review from mhvk July 25, 2023 17:05
@nstarman
nstarman force-pushed the cosmo-latex-identify branch from 4140c34 to 7fd7b95 Compare July 26, 2023 14:12
Signed-off-by: nstarman <[email protected]>
@nstarman
nstarman force-pushed the cosmo-latex-identify branch from 7fd7b95 to 91fcb76 Compare July 26, 2023 14:13
@nstarman nstarman mentioned this pull request Jul 30, 2023
@nstarman
nstarman requested a review from taldcroft July 31, 2023 18:43

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

Looks good and basically ready for approval.

The only question I have is that I couldn't find any rendered version of the updated write_latex docstring in the docs to review.

Also, in the cosmology Read, Write ... section, there is no place that ascii.latex is explicitly mentioned so it isn't clear how the user will discover format="ascii.latex".

@nstarman

nstarman commented Aug 1, 2023

Copy link
Copy Markdown
Member Author

The only question I have is that I couldn't find any rendered version of the updated write_latex docstring in the docs to review.

Yeah, the cosmology I/O docs need some work. This is being done in #15090.

Also, in the cosmology Read, Write ... section, there is no place that ascii.latex is explicitly mentioned so it isn't clear how the user will discover format="ascii.latex".

It should be in the list of write formats in the I/O table... If not #15090 will take of that!

@nstarman
nstarman requested a review from taldcroft August 1, 2023 18:36

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

Looks good!

@nstarman
nstarman merged commit f0dff98 into astropy:main Aug 1, 2023
@nstarman

nstarman commented Aug 1, 2023

Copy link
Copy Markdown
Member Author

Thanks @taldcroft for the reviews!

@nstarman
nstarman deleted the cosmo-latex-identify branch August 1, 2023 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants