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

PEP257 docstrings for file "./docs/conf.py" #1264

Closed
insspb opened this issue Dec 23, 2019 · 0 comments · Fixed by #1304
Closed

PEP257 docstrings for file "./docs/conf.py" #1264

insspb opened this issue Dec 23, 2019 · 0 comments · Fixed by #1304
Labels
code style This issue/PR relates to the project code style modification please-help This issue/PR contain help request to cookiecutter users or first-time contributors

Comments

@insspb
Copy link
Member

insspb commented Dec 23, 2019

Cover ./docs/conf.py file with docstrings and follow PEP257. We use pydocstyle for validation.

Current validation log:

./docs/conf.py:1 at module level:
        D100: Missing docstring in public module
./docs/conf.py:28 in public class `Mock`:
        D101: Missing docstring in public class
./docs/conf.py:29 in public method `__init__`:
        D107: Missing docstring in __init__
./docs/conf.py:32 in public method `__call__`:
        D102: Missing docstring in public method
./docs/conf.py:36 in public method `__getattr__`:
        D105: Missing docstring in magic method

Subtask for #742

@insspb insspb added this to To do in 1.7.1 Release via automation Dec 23, 2019
@insspb insspb added please-help This issue/PR contain help request to cookiecutter users or first-time contributors code-quality-cleanup labels Dec 23, 2019
1.7.1 Release automation moved this from To do to Done Feb 4, 2020
@insspb insspb added the code style This issue/PR relates to the project code style modification label Apr 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code style This issue/PR relates to the project code style modification please-help This issue/PR contain help request to cookiecutter users or first-time contributors
Projects
No open projects
1.7.1 Release
  
Done
1 participant