Docstring

In Python, a docstring is a string literal that occurs as the first statement in a module, function, class, or method definition and works as the code’s documentation.

To define docstrings, you typically use multiline string literals enclosed in triple quotes ("""). Docstrings provide a convenient way to associate documentation directly with the code. They allow you and others to understand what the code does, its parameters, return values, and any other relevant information.

Using docstrings is a best practice for making your code more maintainable and readable. They serve as an immediate reference for anyone who needs to understand or use the code, including future you!

Example

Here’s an example of how you can use docstrings to document a function:

Python 
def add(a, b):
    """Sum two numbers.

    Args:
        a (int or float): The first number.
        b (int or float): The second number.

    Returns:
        int or float: The sum of the two numbers.
    """
    return a + b

In this example, the docstring explains what the add() function does and describes its arguments and return value.

Documenting Python Code Guide

Tutorial

Documenting Python Code: A Complete Guide

A complete guide to documenting Python code. Whether you're documenting a small script or a large project, whether you're a beginner or seasoned Pythonista, this guide will cover everything you need to know.

intermediate best-practices

For additional information on related topics, take a look at the following resources:

By Leodanis Pozo Ramos • Updated Dec. 19, 2024 • Reviewed by Dan Bader
Python Glossary Share Feedback