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 ▸Explain why creating a list of several instances of one element using something like my_list = [a] * 5 can result in strange behaviour
Define a function that takes in the age of the user and adds it to an output sentence such as "You are ..... old".
What are the main data structures that I can use in Python
How do For Loops work?