Skip to content

[issue-3288][slice-6/6] Shared docstrings + bounded high-density... - #3323

Merged
jwbron merged 6 commits into
mainfrom
egg/issue-3288/slice-6
Jun 26, 2026
Merged

[issue-3288][slice-6/6] Shared docstrings + bounded high-density...#3323
jwbron merged 6 commits into
mainfrom
egg/issue-3288/slice-6

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

De-ledger shared/ .py module/param docstrings (coder), sweep the highest-density remaining docs into current-state prose (documenter), and CLOSE with an explicit enumerated list of the deferred long-tail files (per HITL cq-1 opt-1) so coverage is auditable — never imply 100%. No automated lint/CI guard is added (HITL cq-2 opt-1); it is noted as a follow-up.

Base PR: #3317

What's in this PR

Commits (3):

.egg-state/brc-history/3288-implement-slice-6.json | 631 ++++++++++++++++++++++++++++++++++++++
 .egg-state/brc-history/3288-implement-slice-6.md   | 677 +++++++++++++++++++++++++++++++++++++++++
 docs/guides/concurrent-execution.md                | 116 +++----
 docs/guides/per-agent-models.md                    |  65 ++--
 docs/reference/agent-wait-patterns.md              | 459 +++++++++++-----------------
 docs/reference/orchestrator-cli.md                 |  17 +-
 shared/egg_agent/__main__.py                       |  18 +-
 shared/egg_agent/context_discipline.py             |  18 +-
 shared/egg_anchor/protected_root.py                |  12 +-
 9 files changed, 1597 insertions(+), 416 deletions(-)

This slice

Shared docstrings + bounded high-density sweep; enumerate deferred tail

Files affected:

  • shared/egg_anchor/protected_root.py
  • shared/egg_agent/context_discipline.py
  • shared/egg_agent/__main__.py
  • docs/reference/agent-wait-patterns.md
  • docs/guides/concurrent-execution.md
  • docs/reference/orchestrator-cli.md
  • docs/guides/per-agent-models.md
Tasks (2) + acceptance criteria
  • task-6-1: Clean shared/ module/param docstrings framed by slice numbers: shared/egg_anchor/protected_root.py, shared/egg_agent/context_discipline.py, and shared/egg_agent/main.py (docstrings referencing "BRC context discipline: protected directive root + queryable environment, bounded by a deterministic threshold reseed #3200 slice-6", "the slice-8 gate", etc.). Rewrite each to describe the current responsibility of the module/parameter; keep an issue link only as rationale where it explains a non-obvious design. No code/ control-flow changes — docstrings/comments only.
    • Acceptance criteria: - protected_root.py, context_discipline.py, and main.py docstrings describe current responsibilities with no slice-NUMBER framing; retained links are rationale. - No behavior change; the shared test suite stays green.
  • task-6-2: Bounded sweep of the highest-density remaining docs: docs/reference/agent-wait-patterns.md (~55 refs), docs/guides/concurrent-execution.md (~16), docs/reference/orchestrator-cli.md (~13), docs/guides/per-agent-models.md (~9). Rewrite change-log narration ("slice-N added…", "used to… now…") into current-behavior descriptions and strip slice/TASK/phase-iteration references; keep issue links only as rationale. Do NOT touch docs/templates/plan.md (its TASK-N references document the live plan format) or docs/architecture/* (slices 2-3). Then, in the PR body / handoff notes, record an EXPLICIT enumerated list of the deferred long-tail files/areas not cleaned in this pipeline (per HITL cq-1 opt-1), and note the optional lint/CI guard as a follow-up (cq-2). Do not create a new "deferred files" ledger doc in the corpus — the enumeration lives in the PR/handoff, not as durable process archaeology.
    • Acceptance criteria: - The four listed docs read as current-behavior descriptions with no slice/TASK/phase-iteration ledger references (retained links are rationale). - docs/templates/plan.md and docs/architecture/* are untouched. - The PR/handoff carries an explicit enumerated deferred-files list and a note that the lint guard is a follow-up; no new ledger doc is added to the corpus.

Stack

egg and others added 4 commits June 26, 2026 22:24
Rewrite slice-number-framed docstrings and comments in
shared/egg_anchor/protected_root.py, shared/egg_agent/context_discipline.py,
and shared/egg_agent/__main__.py to describe current module/parameter
responsibilities. Issue links (#3200, #3189, #3163, #3249) kept as design
rationale; slice-N / task-N / phase-iteration tags removed. The change-log
phrasing in context_discipline.py is reframed as current behavior. No
code or control-flow changes — docstrings/comments only.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Rewrite SDLC-process change-log narration into present-tense
current-behavior descriptions across the four highest-density docs and
strip slice-N / TASK-N / phase-iteration (cq-N) ledger references,
keeping issue links only where they read as design rationale and
preserving live slice-DAG domain vocabulary and CLI syntax.

- agent-wait-patterns.md: collapse the §10 BRC-wrapper change-log
  framing (PRE-#2908 / STEADY-STATE, deleted-in-slice-4, rollout
  chronology) into a single current-state snapshot; delete the
  od-N/slice-N cross-slice open-decision index table.
- concurrent-execution.md: rewrite the Consensus Wrapper section to the
  orchestrator-owned event-loop end state; de-ledger Slice-PR-Stack and
  schema-migration prose; keep the live slice-DAG model intact.
- orchestrator-cli.md: drop slice/task tags from CLI-row prose; drop the
  removed EGG_EVENT_LOOP_OWNER row; restate PRMetadata in present tense.
- per-agent-models.md: drop slice-2 'plumbing' framing and the cq-N HITL
  decisions table; keep the live multi-slice restart example.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@jwbron
jwbron changed the base branch from egg/issue-3288/slice-1 to main June 26, 2026 22:43
jwbron added 2 commits June 26, 2026 15:44
# Conflicts:
#	docs/guides/concurrent-execution.md
#	docs/reference/agent-wait-patterns.md
@jwbron
jwbron merged commit dc499b0 into main Jun 26, 2026
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant