Standards¶

This document defines the code and documentation standards used in this repository.

Code Standards¶

The code in this repository conforms to standards set by the following tools:

ruff for code formatting and linting
basedpyright for static type checking (with pyrefly as a secondary pass)

See also: How-to guides lint and static-analysis.

Documentation Standards¶

Docstrings are pre-processed using mkdocstrings. Google-style docstrings are considered standard for this repository. Please use type hints in function signatures. For example:

def func(arg1: str, arg2: int) -> bool:
    """Summary line.

    Extended description of function.

    Args:
        arg1: Description of arg1
        arg2: Description of arg2

    Returns:
        Description of return value
    """
    return True

Documentation is contained in the docs directory.