Open zbpetersbuf opened 1 month ago
great! I'll do the documentation
what does this mean exactly? do you need anything from me to do this?
@iamtomato761 @zbpetersbuf yes and no, you can add your code and ideally you work together ion the docstrings and @iamtomato761 can write a short description of the general idea of the function.
are the doc strings the little boxes you add to Jupiter notebook?
docstrings are python documentation, see for example here: https://peps.python.org/pep-0257/ or the example from class: https://github.com/ubsuny/CompPhys/blob/main/ReviewPython/docstrings/multiline.ipynb
I ll work on this task for the code