Work on docstrings for LCA, Parsl, utils, metrics

JDACS4C-IMPROVE / IMPROVE

Libraries and scripts for basic IMPROVE functionalities

MIT License

1 stars 3 forks source link

Work on docstrings for LCA, Parsl, utils, metrics #163

Open jonesse3 opened 2 weeks ago

jonesse3 commented 2 weeks ago

https://github.com/JDACS4C-IMPROVE/IMPROVE/tree/sara/docstrings2

Make sure they are in google-style convention style.

adpartin commented 2 weeks ago

I did the metrics and utils. I will do LCA. Let's wait for Andreas to finish the CSA code, and then you can do it.

jonesse3 commented 2 weeks ago

OK, we can ignore the changes I made. However, will CSA replace parsl_csa because I also made docstrings in there? If so, I can just delete this branch.

jonesse3 commented 2 weeks ago

Again feel free to compare the changes to see if there's anything you like.

I made sure that I used Google-style convention with the following features:

Module-level docstring
Function-level docstring with type hints in the function signature and not in the Args
Made sure Raises is included if the code has any Exceptions
Help statements formatted the same way and clearer

jonesse3 commented 4 days ago

What's the status of this @adpartin ? Have the changes been pushed for what was done ~ utils.py and metrics.py?

Shall I go ahead and just delete this branch: https://github.com/JDACS4C-IMPROVE/IMPROVE/tree/sara/docstrings2?

Also, what about the docstrings for parsl_csa? I had done this in this branch, but now it sounds like we aren't keeping CSA for this release.

jonesse3 commented 4 days ago

I'll just make a new issue for parsl_csa docstrings.