[wip] pydocstyle

[mfrasco]

Pull Request

Status

This PR is a work in progress. I have finished docstrings for the baseline, experiments, and data modules and confirmed that these files do not generate any linter errors. I wanted to create the PR now, so that I can get early feedback from the team and also make it easier for the team to review the code in small chunks.

Description

In order to standardize the code, I added and fixed docstrings according to pydocstyle, which was requested in #97

How Has This Been Tested?

This only includes changes to docstrings.

• No
• Yes

Checklist:

• My code follows OCF's coding style guidelines
• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works
• I have checked my code and corrected any misspellings

[mfrasco]

I will work on documenting the functions in models next (there are a lot!). Let me know if you'd like me to split the docstrings for these files into multiple commits or multiple PRs to make it easier to review.

[jacobbieker]

I will work on documenting the functions in models next (there are a lot!). Let me know if you'd like me to split the docstrings for these files into multiple commits or multiple PRs to make it easier to review.

Thanks for tackling this! I think its fine all being in the same PR, I can try reviewing things as you add more.

[jacobbieker]

This all looks fantastic! Thanks so much!