Skip to content

Document Python docstring style guide #312

@aaronsteers

Description

@aaronsteers

As uncovered here, we should be better documenting the docstring standards we have for Python.

In short, our docstring standard as of today is that we use the Google format. Basically, I think we use the standard off-the-shelf standard - except also do not put parameter type hints into docstrings when those are redundant with the method/function signature as already required by mypy.

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