search

bandframework / Taweret

Python package for Bayesian Model Mixing
https://bandframework.github.io/Taweret/
MIT License
8 stars 8 forks source link

Clean Sphinx docs for release #115

Closed jared321 closed 2 months ago

jared321 commented 2 months ago

@asemposki I did a full review of the changes in this PR. As part of that, I took the liberty of fully converting the docstrings for a utils function to LaTeX. I also updated the version of the package to v1.1.0 since the sphinx docs were showing v1.0.1.

All the changes look good locally and in the RTD rendered as part of the PR. All GH actions passing.

Please do a careful review to make sure that I didn't break any of the content with my changes. Please merge once you are happy with the changes.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 66.62%. Comparing base (f88524a) to head (478d618). Report is 15 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #115 +/- ## ========================================== + Coverage 66.60% 66.62% +0.02% ========================================== Files 14 14 Lines 1560 1561 +1 ========================================== + Hits 1039 1040 +1 Misses 521 521 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

asemposki commented 2 months ago

@jared321 Everything looks good, I just added a couple edits to the docs to make sure the docstrings are all consistent. Thanks for finding all of those typos from when we hastily constructed the documentation last year or longer ago!