What are some examples of docstring formatting in Python?

Can you show me some examples of how to format docstrings in Python?

Sure! In Python, docstrings are used to describe modules, classes, and functions. Here's an example for a function:

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

    Parameters:
    a (int): The first number.
    b (int): The second number.

    Returns:
    int: The sum of a and b.
    """
    return a + b

What about class docstrings?

Here's an example of a class docstring:

class Calculator:
    """
    A simple calculator class.

    Methods:
    add(a, b): Returns the sum of a and b.
    subtract(a, b): Returns the difference of a and b.
    """

    def add(self, a, b):
        return a + b

    def subtract(self, a, b):
        return a - b

Are there any conventions I should follow?

Yes, it's recommended to follow PEP 257 conventions for docstrings. This includes using triple quotes, starting with a summary line, and including parameter and return type descriptions.