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

Correct the mentioned pylint errors to get perfect 10. (missing-docstring) #179

Open
LordGameleo opened this issue Mar 19, 2019 · 3 comments · May be fixed by #187
Open

Correct the mentioned pylint errors to get perfect 10. (missing-docstring) #179

LordGameleo opened this issue Mar 19, 2019 · 3 comments · May be fixed by #187
Labels
good first issue help wanted

Comments

@LordGameleo
Copy link
Contributor

We are currently using a customized checklist for pylint. We have disabled a lot of checks to make our build successfully. We want to counter these checks few at a time. This issue deals with one of them.

How to produce:

After forking and cloning this repo, make a branch named develop-Pylint_docstring using
git branch develop-Pylint_docstring

Checkout branch by
git checkout develop-Pylint_docstring

remove missing-docstring, from .pylintrc file (line 24)

Check pylint errors using
pylint * on terminal (in the repo)

Add doc strings to get a perfect 10 score on pylint.
@LordGameleo
Copy link
Contributor Author

@Rechi @razzeee Please add first timers only and help wanted label

@LordGameleo LordGameleo changed the title Adding doc strings to all the modules to get perfect 10 for pylint. Correct the mentioned pylint errors to get perfect 10. (missing-docstring) Mar 19, 2019
@mzfr mzfr linked a pull request Mar 19, 2019 that will close this issue
Open
@ajaykhgupta
Copy link

Hey, Can you assign this issue to me.
Also would like to know what docstring is it just to define the usage of class?

@razzeee
Copy link
Member

razzeee commented Apr 6, 2023

It's the description of a method or class

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add docstrings mzfr/addon-check
4 participants
@Rechi @razzeee @LordGameleo @ajaykhgupta