Skip to content

[issue-3288][slice-4/6] Gateway docstrings + gateway/CLAUDE.md - #3321

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

[issue-3288][slice-4/6] Gateway docstrings + gateway/CLAUDE.md#3321
jwbron merged 7 commits into
mainfrom
egg/issue-3288/slice-4

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

De-ledger gateway/ .py docstrings and inline comments (coder) and re-key the gateway/CLAUDE.md submodule seam tables by current structure (documenter). Docstring/comment edits only — no code-behavior change; keep load-bearing rationale links.

Base PR: #3317

What's in this PR

Commits (6):

.egg-state/brc-history/3288-implement-slice-4.json | 1383 ++++++++++++++++++++++++++++++
 .egg-state/brc-history/3288-implement-slice-4.md   | 1842 ++++++++++++++++++++++++++++++++++++++++
 gateway/CLAUDE.md                                  |   53 +-
 gateway/artifact_api.py                            |    6 +-
 gateway/jira_client.py                             |   40 +-
 5 files changed, 3267 insertions(+), 57 deletions(-)

This slice

Gateway docstrings + gateway/CLAUDE.md

Files affected:

  • gateway/artifact_api.py
  • gateway/jira_client.py
  • gateway/CLAUDE.md
Tasks (2) + acceptance criteria
  • task-4-1: Clean gateway/ .py docstrings and comments. In gateway/artifact_api.py, rewrite the module docstring """Artifact API endpoints on the gateway (#3077 slice-4).""" to describe the endpoints' current purpose without the slice tag (keep a bare Design: coordination state is served, not replicated — retire git/prompt choreography for agent state exchange #3077 rationale link only if it explains why the endpoint exists). In gateway/jira_client.py, strip the # Issue #1557 slice-2 … markers from the affected methods, keeping any genuinely useful rationale as a present-tense comment. No code/control-flow changes — comments/docstrings only.
    • Acceptance criteria: - artifact_api.py module docstring describes current behavior with no "slice-4" tag. - jira_client.py method comments carry no "slice-2" ledger markers; retained text is current-state rationale. - No behavior change; the gateway test suite stays green.
  • task-4-2: Re-key the submodule seam tables in gateway/CLAUDE.md. Today they are organized by which slice landed each decomposition; reorganize them to describe the current submodule structure (module → responsibility), dropping the slice-landed column. Keep the decomposition-pattern rationale link.
    • Acceptance criteria: - The gateway/CLAUDE.md seam tables are organized by current structure, not by which slice landed each piece; no slice-N references remain; retained links are rationale.

Stack

egg and others added 7 commits June 26, 2026 21:54
Rewrite the artifact_api.py module docstring and identifier comment,
and the jira_client.py remotelink/transition method comments, to
describe current behavior without slice-N / decision-N process-ledger
tags. Comments and docstrings only; no code or control-flow change.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Replace the slice-keyed 'Submodule seam tables' (TBD placeholders,
'lands in slice-N' narration, slice-landed columns for decompositions
that have not landed) with a current-state module layout: each live
gateway module mapped to its responsibility. The decomposition pattern
is kept as forward rationale, not a ledger.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Remove refine-Q/architect-D/decision-N/feedback-Q/Open-Q/risk-R
iteration tags from the JiraClient module docstring, _request, edit_ticket,
and link_create docstrings, keeping the substantive present-tense rationale
(429 retry policy, 404 envelope, notify_users default, idempotency-cache
dedupe). Comment/docstring-only; no control-flow change.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…-site notes

Strip residual process-ledger tags from the two enumerated gateway .py targets flagged by reviewer_code_holistic and tester. artifact_api.py: 'STRICT (HITL Q2 of #3077)' becomes 'Strict no-path schema (#3077)', keeping the path-traversal-hardening rationale and the justifying issue link while dropping the HITL-Q tag. jira_client.py: drop the 'refine decision #10' tag from the JiraClient class docstring, keeping the multi-site single-file drop-in rationale. Docstring-only; no control-flow change. Both files parse clean. gateway/CLAUDE.md (documenter boundary) was already re-keyed to current submodule structure in 883cac0.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Drop the SDLC refine-phase reference from the JIRA_WRITE_VERBS_DENIED
comment; state the permanent-denial rationale as current behavior.

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:42
@jwbron
jwbron merged commit 6f10fa2 into main Jun 26, 2026
28 of 30 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