search

villano-lab / nrCascadeSim

calculating the NR spectrum resulting from neutron-capture cascades.
MIT License
0 stars 1 forks source link

Units for inputs and return values of library functions #78

Closed villaa closed 2 years ago

villaa commented 2 years ago

Issue

The units for the inputs of the library files were sporadically documented. This is an attempt to systematically fix that.

Does your pull request resolve or partially resolve an issue? Yes / No.

If Yes, which issue?

Issue #74

Does your pull request implement code improvements? Yes / No.

Does your pull request implement any breaking changes? Yes / No.

If breaking changes are implemented, please describe:

Testing:
This pull request: [ ] Alters the existing CI in some way. [ ] Adds a new step to the CI. [ X] Does not introduce any features that the CI could not already test. [ ] Is not accompanied by necessary CI changes due to some limitation described below. (Please also describe how new features can be manually tested.)

See the README.md file in the nrCascadeSim/tests directory for more instructions on how to make tests.