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 ▸

What is the difference between a cycle "if" and "while"?


[Exam style] Python is an interpreted language. Explain what this means and how interpreted languages differ from compiled languages.


How do you write code to implement a recursive fibonacci algorithm?


Which four data types are used in Python? Can you give an example of each?