Skip to content

Add docstrings for more methods #51

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.

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

Merged
merged 27 commits into from
May 11, 2025
Merged

Add docstrings for more methods #51

merged 27 commits into from
May 11, 2025

Conversation

abhro
Copy link
Member

@abhro abhro commented Apr 9, 2025

  • Add docstrings for ΛCDM types, a2E, scale_factor, E, H, hubble_dist, hubble_time (and their present counterparts), Z
  • Add project dependency on DocStringExtensions
  • Add docs dependency on DocumenterCitations
    • Add citations for some of the code used
  • Add new page for internals, so that it can serve as an easy reference for package devs

Copy link

codecov bot commented Apr 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2cb1082) to head (6bc463e).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master       #51   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines           74        74           
=========================================
  Hits            74        74           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@abhro
Copy link
Member Author

abhro commented Apr 12, 2025

The doc previews keep failing, requesting someone with permissions to look at Documenter keys

@abhro abhro marked this pull request as ready for review April 23, 2025 13:34
@abhro abhro requested a review from sefffal April 23, 2025 13:34
@abhro abhro merged commit 81880db into master May 11, 2025
14 of 16 checks passed
@abhro abhro deleted the add-docstrings branch May 11, 2025 03:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant