Annotated Doc

0.0.4 · active · verified Sat Mar 28

A Python library that enables inline documentation of parameters, class attributes, return types, and variables using the `Annotated` type hint. Current version: 0.0.4. Release cadence: irregular, with the latest release on November 10, 2025.

Warnings

breaking The `Doc` class is located in the `annotated_doc` module, not `annotated-doc` as the package name might suggest.
Fix: Use `from annotated_doc import Doc` to correctly import the `Doc` class.
gotcha The `Doc` class is intended for inline documentation and should be used within type annotations.
Fix: Ensure that `Doc` is used within type annotations to document parameters, class attributes, return types, and variables.

Install

pip install annotated-doc Install annotated-doc

Imports

Doc
```
from annotated_doc import Doc
```
Ensure correct import path to access the `Doc` class

Quickstart

A simple function demonstrating the use of `Doc` for inline documentation

from typing import Annotated
from annotated_doc import Doc

def greet(name: Annotated[str, Doc('The name of the person to greet')]) -> None:
    print(f'Hello, {name}!')

greet('Alice')

view raw JSON →