1 reporting.notation
reporting.notation
Presentation-free resolution of canonical Typst notation and glossary IDs.
The canonical definitions remain in docs/typst/shared. This module reads their generated YAML projections so Python report builders and Streamlit can validate identifiers and display descriptions without parsing or copying Typst bodies into report recipes.
1.1 Classes
| Name | Description |
|---|---|
| ResolvedNotation | One canonical mathematical concept prepared for report rendering. |
| ResolvedTerm | Display projection and canonical owner link for one glossary term. |
| ResolvedTheory | Resolved equation, symbol, and glossary projections for one request. |
| TheoryReferences | Stable registry identifiers requested by one explanation or result. |
| TheoryResolutionError | Raised when a requested canonical equation, symbol, or term is unavailable. |
1.1.1 ResolvedNotation
reporting.notation.ResolvedNotation(
identifier,
kind,
tex,
typst,
description,
source_url,
name=None,
unit=None,
)One canonical mathematical concept prepared for report rendering.
The Typst domain owner defines the mathematics; glossary-build generates this representation for consumers that cannot evaluate Typst. Identifiers connect a result to its theory without making a report recipe a second formula owner. These fields describe notation, not measured data values.
1.1.1.1 Attributes
| Name | Description |
|---|---|
| identifier | Stable domain-qualified key, such as rl.conditional_q. |
| kind | Selects a symbol or equation owner; identical local names may occur in both. |
| tex | Generated LaTeX math body, without surrounding display delimiters. |
| typst | Executable facade reference such as #symb.rl.conditional_q. |
| description | Plain conceptual explanation, or None when metadata omits one. |
| source_url | Browser link to the domain source, enabling inspection of assumptions and usage. |
| name | Optional concise canonical label; absence preserves legacy fallback. |
| unit | Optional canonical display unit; None means unspecified, not dimensionless. |
1.1.2 ResolvedTerm
reporting.notation.ResolvedTerm(
identifier,
label,
short,
definition,
source_url,
)Display projection and canonical owner link for one glossary term.
1.1.2.1 Attributes
| Name | Description |
|---|---|
| identifier | Requested canonical or supported alias identifier. |
| label | Human-readable canonical label. |
| short | Optional abbreviation. |
| definition | Generated long or short definition. |
| source_url | Browser-valid link to the canonical glossary owner. |
1.1.3 ResolvedTheory
reporting.notation.ResolvedTheory(equations, symbols, terms)Resolved equation, symbol, and glossary projections for one request.
1.1.3.1 Attributes
| Name | Description |
|---|---|
| equations | Equations in requested order. |
| symbols | Symbols in requested order. |
| terms | Glossary terms in requested order. |
1.1.4 TheoryReferences
reporting.notation.TheoryReferences(equation_ids=(), symbol_ids=(), term_ids=())Stable registry identifiers requested by one explanation or result.
1.1.4.1 Attributes
| Name | Description |
|---|---|
| equation_ids | Canonical equation identifiers from generated docs/notation.yml. |
| symbol_ids | Canonical symbol identifiers from generated docs/notation.yml. |
| term_ids | Canonical glossary identifiers from generated docs/glossary/terms.yml. |
1.1.5 TheoryResolutionError
reporting.notation.TheoryResolutionError()Raised when a requested canonical equation, symbol, or term is unavailable.
1.2 Functions
| Name | Description |
|---|---|
| notation_sha256 | Return the content digest of the generated canonical notation projection. |
| resolve_theory | Resolve canonical generated notation without parsing Typst at runtime. |
| validate_theory_registry | Fail unless every requested identifier resolves through generated owners. |
1.2.1 notation_sha256
reporting.notation.notation_sha256(root=None)Return the content digest of the generated canonical notation projection.
1.2.2 resolve_theory
reporting.notation.resolve_theory(references, *, root=None)Resolve canonical generated notation without parsing Typst at runtime.
1.2.3 validate_theory_registry
reporting.notation.validate_theory_registry(references, *, root=None)Fail unless every requested identifier resolves through generated owners.