Skip to content

review: tighten comments, fix stale claims-journal docs#17

Merged
CMGS merged 1 commit into
mainfrom
review/comment-doc-tighten
Jul 9, 2026
Merged

review: tighten comments, fix stale claims-journal docs#17
CMGS merged 1 commit into
mainfrom
review/comment-doc-tighten

Conversation

@CMGS

@CMGS CMGS commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Whole-repo /code /code-rs /code-py comment-budget pass plus a docs-staleness check against the recently merged #12#16. Comment-only + docs; no behavior change. A 5-agent scan flagged ~50 candidates; most were already-tight, load-bearing WHY comments (#7 tightened them) and were deliberately left alone — this PR applies only genuine reductions and two real staleness fixes.

Staleness fixes (the substantive part)

Comment reductions (restate / narrative only)

  • sandboxd/server/server.go redirectClaim: dropped scenario-painting, kept the redirect targets + no_redirect ping-pong WHY.
  • sandboxd/engine/portconn.go guestPortConn: dropped the {op:data}/{type:data} restate-of-code, kept the wire format + purpose.
  • boot/init/src/cfg.rs: removed three test sub-case labels the asserts already state.
  • sdk/openai/.../adapter.py: removed one restate comment (kept the load-bearing # 404-safe in the SDK).

Deliberately NOT changed

Gates

  • Go (sandboxd): go build ✓, go vet darwin+linux ✓, golangci-lint run darwin+linux → 0 issues, golangci-lint fmt --diff clean, go test -race pool/engine/server → ok.
  • Rust (boot/init): cargo fmt --check ✓, cargo clippy --all-targets -D warnings ✓, cargo test parse_ip_param → ok.
  • Python (sdk/openai): ruff check → all passed, py_compile ✓; pytest blocked by the external agents (openai-agents) SDK absent in this env (comment-only change).

docs/performance.md's "Claims-journal write path" stated a decision (keep
the in-mutex write) that F1/F1-part-2 reversed; rewrite it for the
snapshot()/commit() split. claimStore's doc likewise still said the marshal
runs under the manager mutex — F1-part-2 moved it off. Drop restate-of-code
and scenario narrative from a few WHY comments; no behavior change.
@CMGS CMGS merged commit ff315a9 into main Jul 9, 2026
3 checks passed
@CMGS CMGS deleted the review/comment-doc-tighten branch July 9, 2026 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant