One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
a year ago
—
a year old
One-line docstring should fit on one line with quotes
1""" 2Base settings to build other settings files upon.
3"""
4from pathlib import PathOne-line docstring should fit on one line with quotes
8
9
10class TestUserAdminCreationForm:
11 """12 Test class for all tests related to the UserAdminCreationForm
13 """
14One-line docstring should fit on one line with quotes
1""" 2Module for all Form Tests.
3"""
4from django.utils.translation import gettext_lazy as _One-line docstring should fit on one line with quotes
1""" 2With these settings, tests run faster.
3"""
4
Description
If a docstring fits in a single line (72 characters according to PEP8), it is recommended to have the quotes on the same line.
Bad practice
def foo():
"""
Runs bar and returns baz.
"""
baz = bar()
return baz
Recommended
def foo():
"""Runs bar and returns baz."""
baz = bar()
return baz