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 ▸Write a function that takes a list of numbers as input, and outputs the average of the numbers. The function should catch any errors.
What are the main data structures that I can use in Python
Write a program that computes the sum of all numbers up to a input number n
When do we use a for-loop and when a while-loop?