Added units to the docstrings #68
Conversation
There was a problem hiding this comment.
Please check the consistency in abbreviations and unit justification spacings throughout. It also looks like you missed some units that you defined in other places throughout the code. Be sure to Preview each file that you changed to make sure that it renders properly in the JupyterBook.
conflicts resolved base and multiplane :q wq :wq ZZ
Maintained consistent units and spacing throught to the best of my knowledge. However, when renderred in jupyterbook, it shows how it is written in the code itself - |
merged base conflicts
src/caustics/lenses/base.py
Outdated
|
|
||
| x_component: Tensor | ||
| Deflection Angle | ||
|
|
||
| *Unit: arcsec* | ||
|
|
||
| y_component: Tensor | ||
| Deflection Angle | ||
|
|
||
| *Unit: arcsec* | ||
|
|
There was a problem hiding this comment.
This should be right under Returns
src/caustics/lenses/base.py
Outdated
|
|
||
| x_component: Tensor | ||
| Deflection Angle | ||
|
|
||
| *Unit: arcsec* | ||
|
|
||
| y_component: Tensor | ||
| Deflection Angle | ||
|
|
||
| *Unit: arcsec* | ||
|
|
|
|
||
| x_component: Tensor | ||
| Deflection Angle | ||
|
|
||
| *Unit: radians* | ||
|
|
||
| y_component: Tensor | ||
| Deflection Angle | ||
|
|
||
| *Unit: radians* | ||
|
|
There was a problem hiding this comment.
There are probably things that I missed since it's so huge, but we'll just continue working on it in future PRs. Thanks again @RashmikaReddy and @uwcdc for working on this. This is ready to merge after the above issues are fixed.
* 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]>
#53