Skip to content

Update RUFF pre-commit hook for stricter doc string check #159

Description

@osw282

Right now, one liner doc string for function that has arguments and return type will still pass the pre-commit hook.

We want to enforce all args and return type to be included in doc strings.

Check ruff's pydoclint doc to see if enabling more DOC rules would do the job.

D417 might also be needed

Metadata

Metadata

Assignees

Labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions