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 an imput (call it usr_in), the user's age (usr_age) and the user's name (usr_nm) and outputs the following string: "Hi, My name is [usr_nm], I am [usr_age] years old, and my favorite number is [usr_in]"
What is the difference between a for loop and a while loop?
[Exam style] Python is an interpreted language. Explain what this means and how interpreted languages differ from compiled languages.
What is the difference between a float and an integer variable type?