[issue-3288][slice-4/6] Gateway docstrings + gateway/CLAUDE.md - #3321
Merged
Conversation
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>
…into egg/issue-3288-slice-4-documenter/work
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>
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 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):
This slice
Gateway docstrings + gateway/CLAUDE.md
Files affected:
gateway/artifact_api.pygateway/jira_client.pygateway/CLAUDE.mdTasks (2) + acceptance criteria
"""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.Stack
issue-3288egg/issue-3288/slice-1