Open bgoli opened 3 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.
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.