search

Mesnage-Org / pgfinder

Peptidoglycan MS1 Analysis Tool
https://mesnage-org.github.io/pgfinder
GNU Lesser General Public License v3.0
4 stars 2 forks source link

Docstrings #11

Open bobturneruk opened 4 years ago

bobturneruk commented 4 years ago

Add docstrings to functions so we know what they're supposed to do.

bobturneruk commented 3 years ago

e.g. https://github.com/ScottishCovidResponse/simple_network_sim/blob/master/simple_network_sim/common.py

Ankur-AVP-Patel commented 3 years ago

Working on it now! Should be done by tomorrow (also commenting all my code so its easily to follow)

bobturneruk commented 2 years ago

Need to decide on a docstring format.

Ankur-AVP-Patel commented 2 years ago

What are the current suggestions?

ns-rse commented 2 years ago

I think this is mostly covered by #88 as I added Numpy doc-strings (I find them much easier to read in code than restructured text) to most things and that is now merged to master.

If @Ankur-AVP-Patel and @bobturneruk are able to bulk out the descriptions that I didn't know the meaning of that would then allow this issue to be closed.

ns-rse commented 2 years ago

I'm trying to tidy a few loose ends up and get things released to PyPi today or tomorrow. If its possible to round out the docstrings that would be great as the documentation and website will update automagically.