What are some examples of docstring usage in Python?

What are some examples of docstring usage in Python?

Docstrings are used to describe the purpose of a function or module. For example:

def add(a, b):
    """Add two numbers and return the result."""
    return a + b

Can you show me another example?

Sure! Here's an example of a class with a docstring:

class Dog:
    """A class representing a dog."""
    def __init__(self, name):
        self.name = name

What about documenting parameters and return values?

Great question! You can document parameters and return values like this:

def multiply(a, b):
    """Multiply two numbers.
    
    Args:
        a (int): The first number.
        b (int): The second number.
    
    Returns:
        int: The product of a and b.
    """
    return a * b