Docstrings and documentation in Python - Time & Space Complexity

Time Complexity: Docstrings and documentation

O(n)

Understanding Time Complexity

When we write docstrings and documentation in Python, we add extra text to explain what the code does.

We want to understand how adding these explanations affects the time it takes for the program to run.

Scenario Under Consideration

Analyze the time complexity of the following code snippet.

def greet(name):
    """Return a greeting message for the given name."""
    return f"Hello, {name}!"

print(greet("Alice"))

This code defines a function with a docstring and returns a greeting message.

Identify Repeating Operations

Identify the loops, recursion, array traversals that repeat.

• Primary operation: The function runs once per call, no loops or recursion inside.
• How many times: Once each time the function is called.

How Execution Grows With Input

The time to run the function grows only with how many times you call it, not with the docstring size.

Input Size (n)	Approx. Operations
10 calls	10 operations
100 calls	100 operations
1000 calls	1000 operations

Pattern observation: The docstring does not add extra work when running the function.

Final Time Complexity

Time Complexity: O(n)

This means the time grows directly with how many times you call the function, not with the docstring size.

Common Mistake

[X] Wrong: "Adding docstrings makes the program slower because it runs extra code."

[OK] Correct: Docstrings are just text stored with the function and do not run or slow down the program during normal calls.

Interview Connect

Understanding that documentation does not affect runtime helps you focus on what really matters when analyzing code speed.

Self-Check

"What if the function included a loop that printed the docstring multiple times? How would the time complexity change?"

Practice

1. What is the main purpose of a docstring in Python?

easy

A. To store variable values

B. To execute code automatically

C. To explain what a function, class, or module does

D. To import external libraries

Solution

1. Step 1: Understand what docstrings are

   Docstrings are special strings placed right after function, class, or module definitions to describe their purpose.

2. Step 2: Identify the purpose of docstrings

   They help explain what the code does, making it easier for others and yourself to understand.

3. Final Answer:

   To explain what a function, class, or module does -> Option C

4. Quick Check:

   Docstrings = Explanation [OK]

Hint: Docstrings describe code purpose inside triple quotes [OK]

Common Mistakes:

• Thinking docstrings run code
• Confusing docstrings with comments
• Using docstrings to store data

2. Which of the following is the correct way to write a docstring for a function in Python?

easy

A. def func():
// This is a docstring

B. def func():
# This is a docstring

C. def func():
"This is a comment"

D. def func():
'''This function does something'''

Solution

1. Step 1: Identify correct docstring syntax

   Docstrings use triple quotes (''' or """) placed immediately after the function header.

2. Step 2: Check each option

   def func(): '''This function does something''' uses triple single quotes right after the function header, which is correct. Options B and C use comments or double quotes incorrectly. def func(): // This is a docstring uses // which is not valid in Python.

3. Final Answer:

   def func(): '''This function does something''' -> Option D

4. Quick Check:

   Triple quotes after function = docstring [OK]

Hint: Docstrings use triple quotes right after function header [OK]

Common Mistakes:

• Using # instead of triple quotes
• Using single or double quotes only
• Placing docstring before function header

3. What will be the output of the following code?

def greet():
    '''Return a greeting message.'''
    return "Hello!"

print(greet.__doc__)

medium

A. Return a greeting message.

B. None

C. Hello!

D. SyntaxError

Solution

1. Step 1: Understand __doc__ attribute

   The __doc__ attribute of a function returns its docstring, which is the string inside triple quotes right after the function header.

2. Step 2: Check the function's docstring

   The function greet has the docstring 'Return a greeting message.'. So, greet.__doc__ will output this string.

3. Final Answer:

   Return a greeting message. -> Option A

4. Quick Check:

   Function.__doc__ = docstring text [OK]

Hint: Use function.__doc__ to get its docstring text [OK]

Common Mistakes:

• Expecting function return value instead of docstring
• Confusing __doc__ with print output
• Assuming __doc__ is None if no docstring

4. Identify the error in the following code snippet:

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

medium

A. Docstring should use single quotes

B. Missing closing triple quotes for the docstring

C. Incorrect indentation of return statement

D. Function missing return statement

Solution

1. Step 1: Check docstring syntax

   The docstring starts with triple double quotes """ but does not have a closing triple quote before the return statement.

2. Step 2: Identify the error caused

   Without closing triple quotes, Python treats the return line as part of the string, causing a syntax error.

3. Final Answer:

   Missing closing triple quotes for the docstring -> Option B

4. Quick Check:

   Docstrings need opening and closing triple quotes [OK]

Hint: Always close triple quotes in docstrings [OK]

Common Mistakes:

• Forgetting to close triple quotes
• Indenting return inside docstring
• Using single quotes inconsistently

5. You want to write a docstring for a function that calculates the area of a rectangle. Which of the following docstrings best follows good documentation practice?

hard

A. """Calculate the area of a rectangle given width and height.

Parameters:
width (float): The width of the rectangle.
height (float): The height of the rectangle.

Returns:
float: The area of the rectangle."""

B. """Calculate area."""

C. """Area function"""

D. """Returns width * height"""

Solution

1. Step 1: Understand good docstring content

   A good docstring clearly explains what the function does, its parameters, and what it returns.

2. Step 2: Compare options

   """Calculate the area of a rectangle given width and height. Parameters: width (float): The width of the rectangle. height (float): The height of the rectangle. Returns: float: The area of the rectangle.""" provides a clear description, lists parameters with types, and explains the return value. Other options are too short or vague.

3. Final Answer:

   """Calculate the area of a rectangle given width and height. Parameters: width (float): The width of the rectangle. height (float): The height of the rectangle. Returns: float: The area of the rectangle.""" -> Option A

4. Quick Check:

   Good docstrings = clear + parameters + return [OK]

Hint: Include purpose, parameters, and return in docstrings [OK]

Common Mistakes:

• Writing too short or vague docstrings
• Not mentioning parameters or return values
• Using incomplete sentences