How do I use docstrings in Python functions?

How do I use docstrings in Python functions?

Docstrings are used to describe what a function does. You can add them right after the function definition.

Can you show me an example?

Sure! Here's a simple example:

def add(a, b):
    """Returns the sum of a and b."""
    return a + b

What if I want to include parameters in the docstring?

You can describe the parameters and return value like this:

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

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

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

Is there a way to view the docstring after defining the function?

Yes! You can use the help() function or access the __doc__ attribute:

help(add)
print(add.__doc__)