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

[Feature] Replace darglint with pylint.extension.docsparam #155

Open
2 tasks done
saroad2 opened this issue Apr 7, 2022 · 2 comments
Open
2 tasks done

[Feature] Replace darglint with pylint.extension.docsparam #155

saroad2 opened this issue Apr 7, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@saroad2
Copy link
Owner

saroad2 commented Apr 7, 2022

Is your feature request related to a problem? Please describe.
In order to make sure we document all parameters, we have used Darglint in the default template.
In the meanwhile, Pylint's docparams extension have matured enough to be used to check documentation of arguments and can replce the usage of Darglint.

Describe the solution you'd like
We need to wait for the following PRs to be resolved:

Once those are resolved we can switch from Darglint to Pylint

Describe alternatives you've considered
Keep using Darglint.
While I do appreciate the tool of Darglint, I think that leaning toward fewer checkers is the right way to go.
Pylint is very well received in the Python community and is frequently updated, while Darglint haven't been updated for few months now and is maintained by a single developer.

Additional context
Not relevant.

@saroad2 saroad2 added the enhancement New feature or request label Apr 7, 2022
@saroad2
Copy link
Owner Author

saroad2 commented Apr 7, 2022

Waiting for Pylint version 2.13.6

@saroad2
Copy link
Owner Author

saroad2 commented Jun 23, 2022

It seems like not all checks available in Darglint are available in docparams.
Therefore, keeping it for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant