Skip to main content

Module describe

Module describe 

Source
Expand description

What a commit is called: the verb the gesture opened under, the entity its ops touched, and the scope it happened in.

One builder for every tool, because a history list whose rows are written by twenty call sites is a list whose rows disagree. A gesture knows its verb before it knows its object — the object is whatever the ops turn out to name — so the two meet here, at the seal.

Names are read from the document the commit was written against (named), so a label says what a thing was called when it happened rather than chasing a later rename.

The label does not name the scope. Every history row gives the scope a line of its own, recorded at seal beside the ids, so a label that appended in <scope> would say it twice — and say it worse, since the row’s line elides from the left to keep the leaf while the label’s suffix would be truncated leaf-first.

Structs§

Renaming 🔒
A rename-shaped op: the noun for the label it writes, the value the document still holds (the commit is sealed against its pre-image), and the value the op carries. One list, so every renamable label — a title, a type label, a pin’s name or tag, a route’s name, an area’s title, the document’s own — reads the same way.
Said 🔒
What the ops turned out to say: the object half of the sentence, and — where the ops know their verb better than the gesture that opened — the verb to say it with. Naming a thing that had no name is not a rename, whatever the gesture called itself.

Enums§

Label
What a gesture is called, before its ops are known.
Target 🔒
The entity a target names, as a reader would say it. Target rather than the op itself so a run of ops on one entity — the shape nearly every gesture takes — reads as that entity rather than as its op count.

Constants§

EXCERPT 🔒
How wide a quoted excerpt of authored text may read in a label.

Functions§

bare
A bare name, for the places a label points at a thing rather than introducing it (a route’s endpoints, a PDF outline entry): Filter, or untitled block.
between 🔒
A route’s endpoints as a reader points at them — the block each sits on and the pin’s own name — which is how a wire is recognized, since the wire itself is usually unnamed.
called 🔒
The untitled fallback, spelled once: "Filter" or untitled block.
capitalized 🔒
crud_name 🔒
excerpt 🔒
text as a one-line label can carry it: whitespace flattened, clipped to EXCERPT characters with an ellipsis. None when nothing is left to quote.
named 🔒
The target’s display name in doc, the document the op was written against. A create names what it is about to call the entity — the document cannot, since the entity is not in it yet — and everything else reads the name the entity carried before the commit. Kinds with nothing a human would call a name have none.
non_empty 🔒
nonblank 🔒
A name with nothing in it is no name — the one trim, so “untitled” means the same thing everywhere.
one 🔒
renamed 🔒
The sentence a rename-shaped op says, or None when it writes an empty name — clearing a label is not “renaming it to nothing”, so it falls back to naming the entity alone.
renaming 🔒
subject 🔒
What ops acted on: the one entity where they agree on one, a count otherwise.
target 🔒
What an op acts on. Only an artwork payload answers None: it is bytes rather than an entity, and always travels beside the op that places it.