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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file docannometa-0.2.tar.gz.

File metadata

  • Download URL: docannometa-0.2.tar.gz
  • Upload date:
  • Size: 1.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for docannometa-0.2.tar.gz
Algorithm Hash digest
SHA256 5ad666be945955bf3d4c9924a0cf719c83d16bdc16a57f07f27396322b225300
MD5 b46e15a40ccd1633f2937fa579c82d9b
BLAKE2b-256 04043ed5b6698afe2cdedb53a7dbea0ba243315261793f323899cf5861e6d5e8

See more details on using hashes here.

File details

Details for the file docannometa-0.2-py3-none-any.whl.

File metadata

  • Download URL: docannometa-0.2-py3-none-any.whl
  • Upload date:
  • Size: 1.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for docannometa-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b9794eea73d2f8637c4006f39beb24f6cd3684618ab4371215caa9d0fdef4d3f
MD5 419325648fb7fd430981faea81a5fd67
BLAKE2b-256 d74ff8256c436bab6fb3fb81a1ecac24554b04bae52632959e74a5b8b00b76f4

See more details on using hashes here.

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