Skip to content

chore(container-runner): tighten comments - #5589

Open
abcxff wants to merge 1 commit into
stack/feat-container-runner-exit-process-when-the-last-child-stops-ssuvmosofrom
stack/chore-container-runner-tighten-comments-zrxxyxls
Open

chore(container-runner): tighten comments#5589
abcxff wants to merge 1 commit into
stack/feat-container-runner-exit-process-when-the-last-child-stops-ssuvmosofrom
stack/chore-container-runner-tighten-comments-zrxxyxls

Conversation

@abcxff

@abcxff abcxff commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@claude

claude Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Review

This is a pure comment/doc-comment tightening pass over container-runner, no functional code changes (verified every hunk in the diff touches only //, ///, or //! lines / markdown prose).

Findings

Nothing blocking. A few observations:

  • Em dash removal is consistent and complete in all touched Rust files (actor.rs, child.rs, input.rs, main.rs, monitor.rs, proxy.rs) and matches the CLAUDE.md rule against em dashes in prose/comments. README.md still has a handful of leftover em dashes (lines ~187, 242, 280, 347-348) in sections this PR didn't touch — not a blocker since it's out of scope for this diff, but worth a follow-up if the goal is a fully em-dash-clean container-runner/.
  • No information loss from the trims — I checked the two condensations that looked riskiest:
    • main.rs's EXIT doc originally said it's cancelled on "actor stopped, failed start, or signal"; the new version says "last child stopped or a signal." I traced request_exit/EXIT.cancel() call sites and a failed on_start never calls request_exit (the child is never registered, so there's no "last child" to trigger the empty-registry exit path). The new wording is actually more accurate than the old one, not just shorter — nice catch.
    • monitor.rs's module doc dropped the itemized "Memory sources, in preference order" / "CPU sources, in preference order" lists, but that detail is preserved next to the MemSource/CpuSource enum variants themselves (each variant has its own /// doc), so nothing was actually lost, just relocated closer to the code it describes.
    • The Args.port field doc dropped the RIVET_PORT vs PORT platform distinction, but that explanation is still present as an inline comment right above where port is resolved in async_main.
  • "Cloud Run" → "serverless"/"Rivet Compute" renames are a nice cleanup for genericizing the docs/comments away from a specific vendor concept, consistent with keeping this code as a general RivetKit serverless example rather than GCP-specific.

Other categories

  • Bugs/correctness: N/A, no logic changed.
  • Performance: N/A.
  • Security: N/A.
  • Test coverage: N/A, no behavior changed, so no new tests needed.

Nice cleanup — comments read as complete sentences now and match the repo's comment-style conventions.

@abcxff
abcxff force-pushed the stack/feat-container-runner-exit-process-when-the-last-child-stops-ssuvmoso branch from 332c1a8 to 87b61cb Compare August 24, 2026 14:46
@abcxff
abcxff force-pushed the stack/chore-container-runner-tighten-comments-zrxxyxls branch from 102498a to 2e9fde1 Compare August 24, 2026 14:46
@abcxff
abcxff force-pushed the stack/chore-container-runner-tighten-comments-zrxxyxls branch from 2e9fde1 to 5b11c04 Compare August 25, 2026 19:36
@abcxff
abcxff force-pushed the stack/feat-container-runner-exit-process-when-the-last-child-stops-ssuvmoso branch from 87b61cb to 7531a39 Compare August 25, 2026 19:36
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