What are some examples of docstrings in Python?

Can you show me some examples of docstrings in Python?

Sure! A docstring is a string literal that appears right after the definition of a function, method, class, or module. Here's an example:

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

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

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

What should I include in a docstring?

In a docstring, you should include a brief description of the function's purpose, parameters, return values, and any exceptions that may be raised. It's also helpful to provide examples of how to use the function.

Can you give me another example?

Of course! Here's another example for a class:

class Dog:
    """
    A class representing a dog.

    Attributes:
    name (str): The name of the dog.
    age (int): The age of the dog in years.
    """
    def __init__(self, name, age):
        self.name = name
        self.age = age

How do I access a docstring in Python?

You can access a docstring using the __doc__ attribute. For example, print(add.__doc__) will display the docstring for the add function.