What are docstrings and how do I use them to improve my code readability?
Docstrings are strings placed at the beginning of classes, functions, or .py files. They are implemented using three single quotes at the beginning and end. For example:
def Addition(a,b):
''' This function adds a and b together. '''
return a+b
This docstring is then accessed in the interpreter using "Addition.doc"(no quotes). Docstrings are used to document how to use the class, function or script that it refers to, and so can improve code readability and maintainability.
CW
Related Python Mentoring answers
All answers ▸Given a list of N numbers, use a single list comprehension to produce a new list that only contains those values that are: (a) even numbers, and (b) from elements in the original list that had even indices .
Creating string from multiple strings(or characters)
Demonstrate a recursive solution to calculate the factorial of a number
How might we implement the bubble sort algorithm in Python