pydocstyle

What is pydocstyle?

pydocstyle is a static analysis tool for checking compliance with Python docstring conventions.

Report

jeopardy_quiz.py:66 in public function askGoogle: D202: No blank lines allowed after function docstring (found 1)

There's no blank line either before or after the docstring.

jeopardy_quiz.py:102 in public function pop: D205: 1 blank line required between summary line and description (found 0)

Multi-line docstrings consist of a summary line just like a one-line
docstring, followed by a blank line, followed by a more elaborate
description. The summary line may be used by automatic indexing tools;
it is important that it fits on one line and is separated from the
rest of the docstring by a blank line.

jeopardy_quiz.py:121 in public function out: D400: First line should end with a period (not ‘”’)

The [first line of a] docstring is a phrase ending in a period.

jeopardy_quiz.py:174 in public function widgets: D401: First line should be in imperative mood (‘Add’, not ‘Adds’)

[Docstring] prescribes the function or method's effect as a command:
("Do this", "Return that"), not as a description; e.g. don't write
"Returns the pathname ...".

jeopardy_quiz.py:174 in public function widgets: D202: No blank lines allowed after function docstring (found 1)

There's no blank line either before or after the docstring.

jeopardy_quiz.py:174 in public function widgets: D400: First line should end with a period (not ‘w’)

The [first line of a] docstring is a phrase ending in a period.

jeopardy_quiz.py:279 in public function close: D202: No blank lines allowed after function docstring (found 1)

There's no blank line either before or after the docstring.

jeopardy_quiz.py:279 in public function close: D400: First line should end with a period (not ‘p’)

The [first line of a] docstring is a phrase ending in a period.

jeopardy_quiz.py:310 in public function dummy: D401: First line should be in imperative mood (‘Thi’, not ‘This’)

[Docstring] prescribes the function or method's effect as a command:
("Do this", "Return that"), not as a description; e.g. don't write
"Returns the pathname ...".

jeopardy_quiz.py:330 in public function main: D202: No blank lines allowed after function docstring (found 1)

There's no blank line either before or after the docstring.

jeopardy_quiz.py:330 in public function main: D400: First line should end with a period (not ‘n’)

The [first line of a] docstring is a phrase ending in a period.