[Feature request]: Ensure docstring documentation exists in major sub-modules of gempyor

[emprzy]

Label

documentation, gempyor

Priority Label

high priority

Is your feature request related to a problem? Please describe.

In order to generate Sphinx documentation for gempyor, there should be fully fleshed-out docstring documentation at least at the module level in gempyor, ideally for all classes and major functions. Completion of this issue should precede work on GH #458.

Is your feature request related to a new application, scenario round, pathogen? Please describe.

N/A

Describe the solution you'd like

I will comb the sub-modules in gempyor and fill-in missing docstring documentation. Then I will execute on GH #458.

[emprzy]

• compartments.py
• inference.py
• model_info.py
• parameters.py
• utils.py (specifically read_df and write_df

[pearsonca]

Runnings notes:

• Did not add module-level documentation to cli.py, as there isn't much to document. Could go back and add later for consistency's sake?

cli.py is the pipeline, flepimop, not gempyor (conceptually; obviously everything as currently organized is gempyor).

[emprzy]

Runnings notes:

• Did not add module-level documentation to cli.py, as there isn't much to document. Could go back and add later for consistency's sake?

cli.py is the pipeline, flepimop, not gempyor (conceptually; obviously everything as currently organized is gempyor).

I see. So do you have a directive related to inline documentation wrt this or were you just letting me know?

[pearsonca]

Yeah, let's prioritize documentation of gempyor-the-model and gempyor-the-inference tool. for now, gempyor-the-pipeline-aka-flepimop doesn't need docstring - so cli, shared_cli, probably config validator, testing, ...utils? ...profile? ...file_paths? Those are probably down the priority tree.