papyri
{ } Raw JSON

bundles / papyri latest / papyri / nodes / CrossRef

class

papyri.nodes:CrossRef

source: /papyri/nodes.py :138

Signature

class   CrossRef ( * args : Any ,  ** kwargs : Any )  →  None

Members

Summary

A cross-reference produced by the gen step and resolved by ingest.

Extended Summary

reference.kind carries the resolution state:

  • "to-resolve" — placeholder emitted by gen when a best-effort resolution wasn't possible; ingest's relink pass is expected to replace the reference.

  • "missing" — ingest attempted resolution and couldn't find a target; render-time should present as plain text.

  • anything else ("module", "local", "api", ...) — resolved.

exists is a derived property over reference.kind; don't store it.

Aliases

  • papyri.doc.CrossRef