Closed mmcpp16 closed 4 months ago
@mmcpp16 curious about whether or not we should be keeping in the example comments/code for utils or not?
I think it's a helpful addition! As long as they're formatted well and are fairly succinct, I would lean towards keeping them. What do you think?
Yeah, that sounds good. Just wanted to check with someone else if they think this would be valuable
As a developer,
I want to ensure all files have appropriate docstrings/documentation and unnecessary comments are removed,
So that the code is readable, maintainable and can be easily adapted in future versions.
Definition of done: Before code is submitted, we feel each script has necessary documentation that can be understood by an outside party.