Skip to content

Format docstrings so they pass pydocstyle's criteria #1

Description

@JackKelly

Detailed Description

We plan to use pydocstyle to automatically check that our docstrings conform to a standard format. It would be amazing to have help tweaking our existing docstrings to conform!

pydocstyle's list of criteria is here: http://www.pydocstyle.org/en/stable/error_codes.html

Here's the Pull Request (and discussion) about enabling pydocstyle for nowcasting_utils: openclimatefix-archives/nowcasting_utils#23

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions