bad-quotes-docstring (Q002)#
Derived from the flake8-quotes linter.
Fix is always available.
What it does#
Checks for docstrings that use single quotes or double quotes, depending
on the value of the flake8-quotes.docstring-quotes
setting.
Why is this bad?#
Consistency is good. Use either single or double quotes for docstring strings, but be consistent.
Example#
Assuming docstring-quotes
is set to double
, use instead:
Options#
Formatter compatibility#
We recommend against using this rule alongside the formatter. The formatter enforces double quotes for docstrings, making the rule redundant.