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 Object-Oriented Programming?


Firstly, my question is not Python related, but maths A-level related. I don't know how to change that in my profile but I would like to only tutor maths GCSE and potentially A-level. My question: Integrate sin(x)^3 over x=0 and x=pi/2.


Ask the user for a number and output the smallest divisor, bigger than one, for the inputted number. Output "Prime" if the number is a prime number.


[Student query] Why do we import libraries/modules such as Numpy and Matplotlib into Python?