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.

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

Replace darglint with ruff or pydoclint #18

Closed
leandro-lucarella-frequenz opened this issue Apr 12, 2023 · 1 comment · Fixed by #124
Closed

Replace darglint with ruff or pydoclint #18

leandro-lucarella-frequenz opened this issue Apr 12, 2023 · 1 comment · Fixed by #124
Assignees
Labels
part:nox Affects the configuration of nox priority:high Address this as soon as possible type:enhancement New feature or enhancement visitble to users
Milestone

Comments

@leandro-lucarella-frequenz
Copy link
Contributor

leandro-lucarella-frequenz commented Apr 12, 2023

darglint is currently abandoned (the repo is archived).

There is the intention to implement darglint rules in ruff, so when that happens we should replace darglint with ruff.

There is also a python-based alternative that runs much faster, but it doesn't support Google-style comments yet (but it is also planned jsh9/pydoclint#3): https://github.com/jsh9/pydoclint

@leandro-lucarella-frequenz leandro-lucarella-frequenz added status:blocked Other issues must be resolved before this can be worked on type:enhancement New feature or enhancement visitble to users part:nox Affects the configuration of nox labels Apr 12, 2023
@leandro-lucarella-frequenz leandro-lucarella-frequenz changed the title Replace darglint with ruff Replace darglint with ruff or pydoclint May 16, 2023
@leandro-lucarella-frequenz leandro-lucarella-frequenz removed the status:blocked Other issues must be resolved before this can be worked on label May 22, 2023
@leandro-lucarella-frequenz
Copy link
Contributor Author

Unblocking because pydoclint now supports google-style comments!

@llucax llucax modified the milestones: v0.4.0, v0.5.0 Jul 10, 2023
@llucax llucax added the priority:high Address this as soon as possible label Aug 3, 2023
@llucax llucax modified the milestones: v0.5.0, v0.6.0 Aug 11, 2023
@llucax llucax linked a pull request Aug 29, 2023 that will close this issue
@llucax llucax closed this as completed Aug 29, 2023
@github-project-automation github-project-automation bot moved this from To do to Done in Python SDK Roadmap Aug 29, 2023
@llucax llucax self-assigned this Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:nox Affects the configuration of nox priority:high Address this as soon as possible type:enhancement New feature or enhancement visitble to users
Projects
Development

Successfully merging a pull request may close this issue.

2 participants