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

Pydocstyle Linting Errors #10

Open
ModeSevenIndustrialSolutions opened this issue May 14, 2024 · 0 comments
Open

Pydocstyle Linting Errors #10

ModeSevenIndustrialSolutions opened this issue May 14, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@ModeSevenIndustrialSolutions
Copy link
Contributor

pydocstyle...............................................................Failed
- hook id: pydocstyle
- exit code: 1

src/bgsexception.py:1 at module level:
        D100: Missing docstring in public module
src/bgsexception.py:6 in public class `BgsException`:
        D200: One-line docstring should fit on one line with quotes (found 3)
src/bgsexception.py:6 in public class `BgsException`:
        D204: 1 blank line required after class docstring (found 0)
src/bgsexception.py:6 in public class `BgsException`:
        D400: First line should end with a period (not 'n')
src/bgsexception.py:9 in public method `__init__`:
        D107: Missing docstring in __init__
src/bgsexception.py:14 in public class `BgsNotFoundException`:
        D200: One-line docstring should fit on one line with quotes (found 3)
src/bgsexception.py:14 in public class `BgsNotFoundException`:
        D204: 1 blank line required after class docstring (found 0)
src/bgsexception.py:14 in public class `BgsNotFoundException`:
        D400: First line should end with a period (not 'n')
src/bgsexception.py:17 in public method `__init__`:
        D107: Missing docstring in __init__
src/server.py:1 at module level:
        D100: Missing docstring in public module
src/server.py:50 in public function `startup_event`:
        D200: One-line docstring should fit on one line with quotes (found 3)
src/server.py:50 in public function `startup_event`:
        D400: First line should end with a period (not 'r')
src/server.py:68 in public function `status_get`:
        D200: One-line docstring should fit on one line with quotes (found 3)
src/server.py:68 in public function `status_get`:
        D400: First line should end with a period (not 'n')
src/server.py:81 in private function `_task`:
        D200: One-line docstring should fit on one line with quotes (found 3)
src/server.py:81 in private function `_task`:
        D400: First line should end with a period (not 'r')
src/server.py:126 in private function `_repeat_every`:
        D200: One-line docstring should fit on one line with quotes (found 3)
src/server.py:126 in private function `_repeat_every`:
        D400: First line should end with a period (not 'n')
src/server.py:126 in private function `_repeat_every`:
        D401: First line should be in imperative mood; try rephrasing (found 'Setup')
src/utilities.py:1 at module level:
        D100: Missing docstring in public module
src/utilities.py:23 in public function `httprequest`:
        D401: First line should be in imperative mood; try rephrasing (found 'Generic')
src/utilities.py:85 in public function `shttprequest`:
        D401: First line should be in imperative mood; try rephrasing (found 'Generic')
@ModeSevenIndustrialSolutions ModeSevenIndustrialSolutions added the bug Something isn't working label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant