Docstring is over-indented FLK-D208
It is recommended to properly indent docstrings for readability.
Docstring should be indented with spaces, not tabs FLK-D206
It is recommended to use spaces in the docstrings, just as the code.
Missing module docstring PY-D0001
Module docstring is missing. If you want to ignore this, you can configure this in the .deepsource.toml file. Please refer to docs for available options.
No blank lines allowed before class docstring FLK-D211
There shouldn't be any blank lines before the class docstring. Remove the blank lines to fix this issue.
Multi-line docstring closing quotes should be on a separate line FLK-D209
1 blank line required after class docstring FLK-D204
There should be exactly one blank line after the class docstring.
Use r”“” if any backslashes in a docstring FLK-D301
If there are backslashes in a docstring, please use raw strings.
Docstring is under-indented FLK-D207
It is recommended to properly indent docstrings for readability.
Missing class docstring PY-D0002
Class docstring is missing. If you want to ignore this, you can configure this in the .deepsource.toml file. Please refer to docs for available options.
No whitespaces allowed surrounding docstring text FLK-D210
You should avoid spaces at the beginning and at the end of a docstring.
Missing module/function docstring PY-D0003
The module/function docstring is missing. If you want to ignore this, you can configure this in the .deepsource.toml file. Please refer to docs for available options.
Use of single quote detected in docstring FLK-D300
Use of triple-quotes is recommended to specify docstrings.
No blank lines allowed after function docstring FLK-D202
There shouldn't be any blank lines after the function docstring. Remove the blank lines to fix this issue.
No blank lines allowed before function docstring FLK-D201
There shouldn't be any blank lines before the function docstring. Remove the blank lines to fix this issue.
Use of FIXME/XXX/TODO encountered PYL-W0511
You have marked this block as FIXME/XXX/TODO. Please make sure this is addressed, or remove this comment as this could be misleading.
One-line docstring should fit on one line with quotes FLK-D200
If a docstring fits in a single line (72 characters according to PEP8), it is recommended to have the quotes on the same line.
First line should not be the function’s “signature” FLK-D402
The first line of the function docstring has the function's signature, which is not recommended. It shouldn't be specified unless you're specifying or explaining something which might be confusing. It is recommended to remove the redundant function signature from the docstring.