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 docstring linter #730

Open
mvadari opened this issue Jul 16, 2024 · 0 comments · May be fixed by #749
Open

Replace darglint docstring linter #730

mvadari opened this issue Jul 16, 2024 · 0 comments · May be fixed by #749
Labels
documentation Improvements or additions to documentation

Comments

@mvadari
Copy link
Collaborator

mvadari commented Jul 16, 2024

darglint (one of the linters this project uses, for docstrings) is no longer really being maintained. The last update to the repo was 3 years ago.

Some replacement options (source):

  • darglint2
    • Note: this is listed in the description, and was last updated last year, so not sure if it is a good choice

      Important: darglint2 is very slow compared to alternatives due to its parser design. darglint2 is only intended as a low-effort replacement for darglint for those old darglint users who need bugfixes and critical features but don't want to spend the trouble of migrating to a better alternative. See e.g. Another darglint replacement jsh9/pydoclint#9 for details.

  • pydoclint

The best strategy is probably to migrate to darglint2 at first for a drop-in replacement, then migrate to pydoclint later.

@mvadari mvadari added documentation Improvements or additions to documentation good first issue Good for newcomers and removed good first issue Good for newcomers labels Jul 16, 2024
@mvadari mvadari changed the title Replace darglint Replace darglint docstring linter Jul 16, 2024
@mvadari mvadari linked a pull request Sep 17, 2024 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant