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.

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

docs: Create unit glossary #90

Closed
wants to merge 20 commits into from

Conversation

RashmikaReddy
Copy link

No description provided.

RashmikaReddy and others added 18 commits February 15, 2024 11:09
* Added units to the docstrings

* style: pre-commit fixes

* Adding another file

* Made changes to the docstrings

* style: pre-commit fixes

* Made the changes, fixed indentation

* style: pre-commit fixes

* Added spacing, fixed indentation,  added unitless

* Made changes and adjusted the spacing

* style: pre-commit fixes

* docs: Updated units and formatting including cosmology, lenses, and sources

* fix: Removed tuple and moved returns

* fix: Remove tuple from return and moved separated returns

* style: pre-commit fixes

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: uwcdc <[email protected]>
* Added units to the docstrings

* style: pre-commit fixes

* Adding another file

* Made changes to the docstrings

* style: pre-commit fixes

* Made the changes, fixed indentation

* style: pre-commit fixes

* Added spacing, fixed indentation,  added unitless

* Made changes and adjusted the spacing

* style: pre-commit fixes

* docs: Updated units and formatting including cosmology, lenses, and sources

* fix: Removed tuple and moved returns

* fix: Remove tuple from return and moved separated returns

* style: pre-commit fixes

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: uwcdc <[email protected]>
* made changes to units based on suggestions

* style: pre-commit fixes

* Update src/caustics/lenses/pixelated_convergence.py

Co-authored-by: Cordero Core <[email protected]>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Cordero Core <[email protected]>
Copy link

codecov bot commented Mar 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (glossary@f2f02ce). Click here to learn what that means.

Additional details and impacted files
@@             Coverage Diff             @@
##             glossary      #90   +/-   ##
===========================================
  Coverage            ?   92.41%           
===========================================
  Files               ?       40           
  Lines               ?     2135           
  Branches            ?        0           
===========================================
  Hits                ?     1973           
  Misses              ?      162           
  Partials            ?        0           

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

@RashmikaReddy RashmikaReddy marked this pull request as ready for review March 5, 2024 09:31
@uwcdc uwcdc self-requested a review March 5, 2024 22:09
Copy link
Member

@uwcdc uwcdc left a comment

Choose a reason for hiding this comment

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

@RashmikaReddy You need to add the glossary to the _toc.yml file, so you can view it from the rendered JupyterBook. You can use this link to see how it should be updated.

You can access the current _toc.yml file here

I would recommend adding it after the - file: modules

@uwcdc uwcdc changed the base branch from docstrings2 to glossary March 5, 2024 22:20
@uwcdc uwcdc changed the title added glossary docs: Create unit glossary Mar 5, 2024
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.

3 participants