Skip to content

Improve ruff for docstrings #162

@VigneshVSV

Description

@VigneshVSV

Docstrings can be standardized using Ruff. We should start leveraging this to keep docstrings upto date.

Add ruff rules specific to docstrings

  • enforce numpy format
  • at least one line requirement ending with full stop
  • all kwargs and args must match the signature
  • please fill here

Metadata

Metadata

Assignees

No one assigned

    Labels

    beginnerbeginner level good first issues, usually issues that can worked on without skimming the whole repogood first issueGood for newcomers
    No fields configured for Documentation.

    Projects

    Status
    No status

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions