Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cosmo: update docs #16297

Merged
merged 2 commits into from Apr 25, 2024
Merged

cosmo: update docs #16297

merged 2 commits into from Apr 25, 2024

Conversation

nstarman
Copy link
Member

This PR should fix the references in the docs to point to the correct definition of the absorption distance. The prior explanation was confusing and made it seem like the output should have units.

Fixes #16278

@nstarman nstarman requested a review from a team as a code owner April 16, 2024 19:58
@github-actions GitHub Actions
Copy link

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 instructions for rebase and squash.
  • 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?
  • 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.

@nstarman nstarman mentioned this pull request Apr 16, 2024
Closed
@nstarman nstarman added this to the v6.0.2 milestone Apr 16, 2024
@pllim pllim added the Docs label Apr 16, 2024
@pllim pllim modified the milestones: v6.0.2, v6.1.1 Apr 16, 2024
@pllim pllim added the backport-v6.1.x on-merge: backport to v6.1.x label Apr 16, 2024
pllim
pllim reviewed Apr 16, 2024
View reviewed changes
Copy link
Member

@pllim pllim left a comment •
edited

Choose a reason for hiding this comment

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

Thanks!

Is it okay to keep [2] if there is no longer a [1]? Not sure why there is a (1, 2) here:

Screenshot 2024-04-16 171758

https://astropy--16297.org.readthedocs.build/en/16297/api/astropy.cosmology.FLRW.html#astropy.cosmology.FLRW.absorption_distance

@nstarman
Copy link
Member Author

Good point!

@nstarman nstarman requested a review from pllim April 16, 2024 22:47
pllim
pllim approved these changes Apr 16, 2024
View reviewed changes
Copy link
Member

@pllim pllim left a comment

Choose a reason for hiding this comment

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

LGTM as long as @Firestar-Reimu is happy with the updates. Thanks!

@nstarman
Copy link
Member Author

@pllim, updated docs

@pllim
Copy link
Member

pllim commented Apr 25, 2024

@nstarman , can you pls rebase (again) so CI is green? Thanks!

@nstarman
update docs
3e5cd5a 
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
@nstarman
fix reference numbering
1734c1c 
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
@pllim pllim merged commit 2df66aa into astropy:main Apr 25, 2024
27 checks passed
@pllim
Copy link
Member

pllim commented Apr 25, 2024

Thanks!

meeseeksmachine pushed a commit to meeseeksmachine/astropy that referenced this pull request Apr 25, 2024
@nstarman @meeseeksmachine
Backport PR astropy#16297: cosmo: update docs
2db8b79
@meeseeksmachine meeseeksmachine mentioned this pull request Apr 25, 2024
Merged
pllim added a commit that referenced this pull request Apr 25, 2024
@pllim
Merge pull request #16344 from meeseeksmachine/auto-backport-of-pr-16…
3b16934 
…297-on-v6.1.x

Backport PR #16297 on branch v6.1.x (cosmo: update docs)
@nstarman nstarman deleted the cosmo-abs_dist_docs branch April 25, 2024 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pllim pllim pllim approved these changes

Assignees
No one assigned
Labels
backport-v6.1.x on-merge: backport to v6.1.x cosmology Docs no-changelog-entry-needed
Projects
Cosmology, the Expansion
Status: Done
Milestone
v6.1.1
Development

Successfully merging this pull request may close these issues.

the distances in astropy.cosmology
2 participants
@nstarman @pllim