Skip to content

Link to correct documentation page which describes the docstrings style #294

@ashwinvis

Description

@ashwinvis

In the section In-code documentation — How to document your research software documentation it reads

Read more: https://peps.python.org/pep-0257/

although the PEP does not specify any particular format or convention for parsing Python docstrings. The same problem exists for other languages. It could be a good idea to add one more link for further reading:

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