Skip to content

Commit bbae675

Browse files
committed
docs(dataplane): inline phase 2 keep-list into package docstring
Drop the dedicated _phase2_substrate.md and fold its enumeration of deliberately-kept-but-unused names directly into the package docstring at gigaevo/dataplane/__init__.py: lwwr_set / lwwr_get + Lua, HlcTimestamp, the lattice classes, and the 13 NewType identifiers covering events, streams, consumer groups, and causation tracking. The keep-list now lives where Python tooling and IDE introspection already surface it, removing the indirection through an out-of-band markdown file.
1 parent c0e3a07 commit bbae675

2 files changed

Lines changed: 9 additions & 77 deletions

File tree

gigaevo/dataplane/__init__.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,15 @@
1010
1111
Some primitives in this package ship without an in-tree consumer and
1212
are kept as typed substrate for follow-up work (event-streams,
13-
consumer groups, distributed HLC, bandit-router admission); the
14-
keep-list is documented in ``_phase2_substrate.md`` co-located with
15-
this package.
13+
consumer groups, distributed HLC, bandit-router admission). The
14+
deliberately-kept-but-unused names cover ``lwwr_set`` / ``lwwr_get``
15+
and ``scripts/lwwr_set.lua``, ``HlcTimestamp``, the lattice classes
16+
(``BoolLattice``, ``EpochLattice``, ``GenerationLattice``,
17+
``ProductLattice``, ``MonotoneLattice``), and the NewType identifiers
18+
``AggregateId``, ``BanditArm``, ``CausationId``, ``CorrelationId``,
19+
``StreamName``, ``ConsumerGroup``, ``ConsumerName``, ``NodeId``,
20+
``IdempotencyToken``, ``EventId``, ``EpochId``, ``GenerationId``,
21+
``StepId``.
1622
"""
1723

1824
from __future__ import annotations

gigaevo/dataplane/_phase2_substrate.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

0 commit comments

Comments
 (0)