Python

Python

Made by DeepSource

First line should not be the function’s “signature” FLK-D402

Documentation
Minor

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.

Bad practice

def area(a, b):
    '''area(a, b) -> a*b'''
    ...

Recommended

```python def area(a, b): '''Calculates area of rectagnle with sides a and b''' ...