Python Docstring Standards

Applies to: *.py

Write clear and consistent Python docstrings

python

file

1 downloads

118 views

Python Docstring Standards

Function Docstrings

Use Google-style docstrings:

python

def calculate_average(numbers: list[float]) -> float:
    """Calculate the average of a list of numbers.
    
    Args:
        numbers: A list of numeric values.
        
    Returns:
        The arithmetic mean of the numbers.
        
    Raises:
        ValueError: If the list is empty.
        
    Example:
        >>> calculate_average([1, 2, 3, 4, 5])
        3.0
    """
    if not numbers:
        raise ValueError("Cannot calculate average of empty list")
    return sum(numbers) / len(numbers)

Class Docstrings

Document the purpose, attributes, and key methods.

Module Docstrings

Include a brief description of the module's purpose at the top of each file.

Related Instructions

View all →

TypeScript Error Handling

*.ts

Comprehensive error handling patterns for TypeScript applications

typescript

error-handling

101

React Component Best Practices

*.tsx

Guidelines for creating maintainable and performant React components

WordPress Development — Copilot Instructions

Coding standards for wordpress.instructions

VueJS 3 Development Instructions

Coding standards for vuejs3.instructions

TypeScript MCP Server Development

Coding standards for typescript mcp server.instructions

TypeScript Development

These instructions assume projects are built with TypeScript 5.x (or newer) compiling to an ES2022 JavaScript baseline. Adjust guidance if your runtime requires older language targets or down-level transpilation.

Browse More Instructions