Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace darglint with ruff DOC rules. #4454

Open
11 tasks
Lendemor opened this issue Nov 29, 2024 · 1 comment
Open
11 tasks

Replace darglint with ruff DOC rules. #4454

Lendemor opened this issue Nov 29, 2024 · 1 comment
Labels
enhancement Anything you want improved

Comments

@Lendemor
Copy link
Collaborator

Darglint is not maintained anymore, and is very slow.

Alternative to covers the docstring checks:

  • pydoclint: Is actively maintained and the rules mostly make sense, but they are not selectable, so it's all or nothing.
  • ruff DOC rules: These rules are inspired by pydoclint but will give us the flexibility of ruff in selecting the rules we want to apply.

Subset of the rules we need enabled in ruff, before we can remove darglint:

  • DOC101
  • DOC102
  • DOC103
  • DOC104
  • DOC111
  • DOC201
  • DOC202
  • DOC402
  • DOC403
  • DOC501
  • DOC502
@Lendemor Lendemor added the enhancement Anything you want improved label Nov 29, 2024
@linear Linear
Copy link

linear bot commented Nov 29, 2024

ENG-4159 Replace darglint with ruff DOC rules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Anything you want improved
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Lendemor