Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 340 Bytes

missing-class-docstring.md

File metadata and controls

21 lines (14 loc) · 340 Bytes

Pattern: Missing class docstring

Issue: -

Description

Used when a class has no docstring. Even an empty class should have a docstring.

Example of incorrect code:

class Test(object): # [missing-class-docstring]
    pass

Example of correct code:

class Test(object):
    """It has a docstring."""