Document/Unit Test `gempyor.parameters`

TimothyWillard commented 1 month ago

This PR:

Documents the gempyor.parameters module and its only class Parameters,
Adds unit tests for (almost) all of the methods of the Parameters class,
Regulates the exports of gempyor.parameters using the __all__ dunder`.

This PR does not:

Change any of the functionality contained in this module,
Refactor any of the code in this module for readability/performance,
Correct the type hint issues with this module (namely list/dict types not being fully specified),
Test the parameters_reduce method of the Parameters class.

This is the first in one or two more PRs to address GH-276. I didn't implement any tests for parameters_reduce yet because I still need to get a handle on the NPI objects. However, I think it would be best to get this first pass done to set ground for the next pass.

TimothyWillard commented 1 month ago

No need to review yet, still WIP per the suggestions above.

TimothyWillard commented 1 month ago

Above comments have been address and this PR is ready for review again now.

TimothyWillard commented 2 weeks ago

@saraloo, @emprzy, or @pearsonca is there any chance we could get this review and merged soon?

HopkinsIDD / flepiMoP

Document/Unit Test `gempyor.parameters` #277