Skip to content

A standard docstring format for PySCeS #99

@bgoli

Description

@bgoli

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions