update docstrings and examples for units clarity#16
update docstrings and examples for units clarity#16dallasfoster wants to merge 5 commits intoNVIDIA:mainfrom
Conversation
Greptile SummaryThis PR improves unit clarity across the codebase by updating docstrings, examples, and comments to consistently describe the unit system implied by each parameter. It also includes several functional bug fixes: renaming Key changes:
Important Files Changed
Reviews (5): Last reviewed commit: "Merge branch 'main' into dallasf/units" | Re-trigger Greptile |
|
Are you planning to update the sphinx documentation in this PR as well? A brief reference to the text you added to the atomic data class could be helpful |
|
/ok to test 05e7154 |
There was a problem hiding this comment.
LGTM
@WardLT I think the docs were updated; see if that satisfies you and if so I'll merge
|
Docs look good to me too |
Signed-off-by: Dallas Foster <dallasf@nvidia.com>
|
/ok to test 68b9f51 |
Signed-off-by: Dallas Foster <dallasf@nvidia.com>
|
/ok to test 8a4b004 |
ALCHEMI Toolkit Pull Request
Description
Tries to add clarity to the usage of units throughout the package.
Type of Change
Related Issues
Changes Made
Testing
make pytest)make lint)Checklist
Additional Notes
Tip
This repository uses Greptile, an AI code review service, to help conduct
pull request reviews. We encourage contributors to read and consider suggestions
made by Greptile, but note that human maintainers will provide the necessary
reviews for merging: Greptile's comments are not a qualitative judgement
of your code, nor is it an indication that the PR will be accepted/rejected.
We encourage the use of emoji reactions to Greptile comments, depending on
their usefulness and accuracy.