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

Fix missing docstrings on the python files. #1482

Closed
4 tasks
karlcow opened this issue Apr 5, 2017 · 0 comments
Closed
4 tasks

Fix missing docstrings on the python files. #1482

karlcow opened this issue Apr 5, 2017 · 0 comments

Comments

@karlcow
Copy link
Member

karlcow commented Apr 5, 2017

On #1473 there was a discussion about the project having missing docstrings. We didn't create docstrings for all the functions.

The output on view was.

`pep257 webcompat/views.py`
`webcompat/views.py:1 at module level:
        D100: Missing docstring in public module
webcompat/views.py:40 in public function `shutdown_session`:
        D103: Missing docstring in public function
webcompat/views.py:45 in public function `before_request`:
        D103: Missing docstring in public function
webcompat/views.py:54 in public function `after_request`:
        D103: Missing docstring in public function
webcompat/views.py:62 in public function `token_getter`:
        D103: Missing docstring in public function
webcompat/views.py:69 in public function `format_date`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:76 in public function `login`:
        D103: Missing docstring in public function
webcompat/views.py:87 in public function `logout`:
        D103: Missing docstring in public function
webcompat/views.py:97 in public function `authorized`:
        D103: Missing docstring in public function
webcompat/views.py:117 in public function `file_issue`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:127 in public function `index`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:150 in public function `show_issues`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:159 in public function `create_issue`:
        D401: First line should be in imperative mood ('Create', not 'Creates')
webcompat/views.py:208 in public function `show_issue`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:219 in public function `me_redirect`:
        D401: First line should be in imperative mood ('Thi', not 'This')
webcompat/views.py:219 in public function `me_redirect`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:228 in public function `show_user_page`:
        D400: First line should end with a period (not ':')
webcompat/views.py:228 in public function `show_user_page`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:250 in public function `show_rate_limit`:
        D103: Missing docstring in public function
webcompat/views.py:268 in public function `download_file`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:278 in public function `get_test_helper`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:278 in public function `get_test_helper`:
        D200: One-line docstring should fit on one line with quotes (found 2)
webcompat/views.py:286 in public function `about`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:294 in public function `privacy`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:302 in public function `contributors`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:310 in public function `cssfixme`:
        D400: First line should end with a period (not 'l')
webcompat/views.py:310 in public function `cssfixme`:
        D300: Use """triple double quotes""" (found '''-quotes)
webcompat/views.py:316 in public function `log_csp_report`:
        D300: Use """triple double quotes""" (found '''-quotes)
`

There are a couple of recurring issues.

  • missing docstrings
  • Imperative style
  • length
  • quote styles
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants