PySCeS / pysces

The official PySCeS project source code repository.
https://pysces.github.io
Other
34 stars 10 forks source link

A standard docstring format for PySCeS #99

Open bgoli opened 6 months ago

bgoli commented 6 months ago

I've been playing around with using LLM's to generate/convert docstrings and found two docstring formats for Python that are widely used:

I'm considering both to see if there are any quality differences in the AI output but perhaps we should, in general, select one for PySCeS?

Update. It looks like Numpydoc format gives more consistently formatted output so that would be my suggestion to use for new docstrings.