[issue-3288][slice-6/6] Shared docstrings + bounded high-density... - #3323
Merged
Conversation
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>
…into egg/issue-3288-slice-6-documenter/work
# Conflicts: # docs/guides/concurrent-execution.md # docs/reference/agent-wait-patterns.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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):
This slice
Shared docstrings + bounded high-density sweep; enumerate deferred tail
Files affected:
shared/egg_anchor/protected_root.pyshared/egg_agent/context_discipline.pyshared/egg_agent/__main__.pydocs/reference/agent-wait-patterns.mddocs/guides/concurrent-execution.mddocs/reference/orchestrator-cli.mddocs/guides/per-agent-models.mdTasks (2) + acceptance criteria
Stack
issue-3288egg/issue-3288/slice-1