Docstrings and documentation in Python - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a docstring in Python?

A docstring is a special string placed at the beginning of a function, class, or module that explains what it does. It helps others understand the code without reading all the details.

beginner

How do you write a docstring for a function?

You write a docstring by placing a string enclosed in triple quotes (""" or ''') right after the function definition line. For example:

def greet():
    """Prints a greeting message."""
    print('Hello!')

beginner

Why is documentation important in programming?

Documentation helps people understand what the code does, how to use it, and why it was written that way. It makes maintaining and sharing code easier and saves time in the long run.

intermediate

What tool can you use to view a function's docstring in Python?

You can use the built-in help() function or access the __doc__ attribute. For example, help(function_name) or print(function_name.__doc__) will show the docstring.

intermediate

What are some common sections included in a detailed docstring?

Common sections include:
- Description: What the function/class/module does
- Parameters: Inputs the function takes
- Returns: What the function gives back
- Examples: How to use it
These help users understand and use the code correctly.

Where should a docstring be placed in a Python function?

A At the end of the function

B Before the function definition line

C Outside the function, in a separate file

D Immediately after the function definition line

A docstring must be placed right after the function definition line, inside the function body.

Which of these is the correct way to write a docstring?

A """This function adds two numbers."""

B // This function adds two numbers

C # This function adds two numbers

D <!-- This function adds two numbers -->

Python docstrings use triple quotes (""" or ''') to enclose the documentation string.

What does the help() function do when used on a Python function?

A Displays the function's docstring and usage information

B Runs the function

C Deletes the function

D Compiles the function

The help() function shows the docstring and other useful information about the function.

Why should you write docstrings in your code?

A To make the code run faster

B To explain what the code does for others and yourself

C To hide the code from others

D To make the code shorter

Docstrings help explain the purpose and usage of code, making it easier to understand and maintain.

Which of these is NOT typically included in a detailed docstring?

A Parameters description

B Return values

C Code implementation details

D Examples of usage

Docstrings focus on what the code does, not how it is implemented internally.

Explain what a docstring is and why it is useful in Python programming.

Think about how you would tell a friend what a function does without showing the code.

Describe the typical structure of a detailed docstring for a function.

Imagine writing instructions for someone to use your function correctly.