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

Solve pydocstyle errors #19

Open
orviz opened this issue Mar 2, 2022 · 0 comments
Open

Solve pydocstyle errors #19

orviz opened this issue Mar 2, 2022 · 0 comments
Assignees
Labels
1.0.0 Release 1.0.0 bug Something isn't working

Comments

@orviz
Copy link
Contributor

orviz commented Mar 2, 2022

Current set of errors:

openapi_server/controllers/security_controller_.py:1 at module level:
        D100: Missing docstring in public module
openapi_server/controllers/app_controller.py:1 at module level:
        D100: Missing docstring in public module
openapi_server/controllers/app_controller.py:9 in public function `get_ml_app_by_name`:
        D400: First line should end with a period (not 'e')
openapi_server/controllers/app_controller.py:21 in public function `update_ml_app`:
        D400: First line should end with a period (not 'p')
openapi_server/controllers/app_controller.py:21 in public function `update_ml_app`:
        D401: First line should be in imperative mood (perhaps 'Update', not 'Updated')
openapi_server/controllers/__init__.py:1 at module level:
        D104: Missing docstring in public package

Dependencies: pip install pydocstyle

Reference: https://github.com/mitmproxy/pdoc

@orviz orviz added bug Something isn't working 1.0.0 Release 1.0.0 labels Mar 2, 2022
orviz added a commit that referenced this issue Mar 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0.0 Release 1.0.0 bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants