Skip to content

[CI] Linting of docs #1296

@eddiebergman

Description

@eddiebergman

Currently there is no linter for doc and docstrings.

As a follow up, this should really be linted. I would advocate using ruff but theoretically that's blocked on still supporting python 3.6 (#1083).

Should work if working in an environment that's 3.7+ though.

The alternative is to use pydocstyle.

This would prevent issues like #716 from appearing. (which I guess can be closed now?)

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