Skip to content

Every public class, function, class method, and class attribute has a doc string following pydocstyle #109

@christian-oreilly

Description

@christian-oreilly

The use of "ruff check" in .github/workflows/ci.yml and the flag "D" in the select attributed of [tool.ruff.lint] in pyproject.toml should take care of this. However, most of the code is currently in "private" modules (i.e., .py file starting with ). It is unclear to me why these modules were chosen as private. I propose to rename these modules without using the "". This would actually solve this issue... The corresponding PR would not pass the tests until everything that should be documented is.

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