One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
3 years ago
—
3 years old
One-line docstring should fit on one line with quotes
2# pylint: disable=C0116
3# This program is dedicated to the public domain under the CC0 license.
4
5""" 6Basic example for a bot that can receive payment from user.
7"""
8 One-line docstring should fit on one line with quotes
2# pylint: disable=C0116
3# This program is dedicated to the public domain under the CC0 license.
4
5""" 6This is a very simple example on how one could implement a custom error handler
7"""
8import html
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