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

feat(framework) Add example docstring PyLint checker #4280

Draft

mohammadnaseri wants to merge 6 commits into main from add-example-docstring-checker

Contributor

mohammadnaseri commented Oct 3, 2024

This PR adds a new PyLint checker for enforcing example docstring.

mohammadnaseri added 6 commits

October 3, 2024 09:48


          Init

cdcbd83


          Edit

0ae819c


          Edit

dcceedc


          Merge branch 'main' into add-example-docstring-checker

f694f16


          Edit

238809a


          Update __init__.py

42e905e

Member

charlesbvll commented Oct 18, 2024

@mohammadnaseri A few comments:

Could we move the plugin to dev/? I don't think we should have it in the root of the project
Currently, PyLint cannot import the plugin:

Command line or configuration file:1:0: E0013: Plugin 'pylint-custom-checkers.docstring_example_checker' is impossible to load, is it installed ? ('No module named 'pylint-custom-checkers'') (bad-plugin-value)

Lastly, I think we should ignore docstrings that only contain one line, as those correspond to non-public APIs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

danieljanes Awaiting requested review from danieljanes danieljanes will be requested when the pull request is marked ready for review danieljanes is a code owner

tanertopal Awaiting requested review from tanertopal tanertopal will be requested when the pull request is marked ready for review tanertopal is a code owner

At least 1 approving review is required to merge this pull request.

Labels

None yet