One-line docstring should fit on one line with quotes FLK-D200
Documentation
Minor
3 years ago
—
4 years old
One-line docstring should fit on one line with quotes
1"""Python program for implementation of Insertion Sort 2"""
3def insertion_sort(arr):
4 # Traverse through 1 to len(arr) One-line docstring should fit on one line with quotes
1"""Python3 program to sort an array 2"""
3
4 One-line docstring should fit on one line with quotes
1"""Python3 Optimized implementation of Bubble sort 2"""
3
4 One-line docstring should fit on one line with quotes
1"""Python Program implementation of binary insertion sort 2"""
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