`papyri.cli.describe:describe`

source: /papyri/cli/describe.py :10

Signature

   def     describe (    qualname  :  Annotated[str, typer.Argument(help="Qualified name to describe, e.g. 'numpy.linspace'. Optional prefixes select a kind or package: 'module:numpy.linspace', 'docs:intro', 'numpy/1.26.0/module/numpy.linspace'.")]    ,    kind  :  Annotated[str | None, typer.Option(help='Restrict to a specific kind: module, docs, examples, meta, assets.')]    =  None   ,    package  :  Annotated[str | None, typer.Option(help='Restrict to a specific package name.')]    =  None   ,    version  :  Annotated[str | None, typer.Option(help='Restrict to a specific package version.')]    =  None     )   →  None

Summary

Print the IR entry for a given qualified name, without rendering.

Extended Summary

Looks up an ingested document in ~/.papyri/ingest/ and prints its decoded structure, backrefs, and forward refs. Intended as a maintainer-side debug tool for inspecting the IR.

Aliases

papyri.describe