Skip to main content

Document symbols via annotation metadata, as described by PEP 727.

Project description

Python documentation annotation metadata

Document symbols via annotation metadata, as described by PEP 727.

This will become an alias to the same functionality in typing_extensions if and when it is implemented.

Installation

pip install docannometa

Usage

from typing import Annotated

from docannometa import Doc

def repeat(
    text: Annotated[str, Doc("String to repeat")],
    n: Annotated[int, Doc("Number of times to repeat")],
) -> Annotated[str, Doc("Result string of length `n * len(text)`")]:
    """Repeat a string multiple times then concatenate."""
    return text * n

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docannometa-0.2.tar.gz (1.3 kB view hashes)

Uploaded Source

Built Distribution

docannometa-0.2-py3-none-any.whl (1.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page