docs(pegboard-runner): explain alloc idx eviction invariant#4626
Conversation
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
PR Review: docs(pegboard-runner): explain alloc idx eviction invariantThis is a documentation-only change adding two comment lines to clarify a subtle synchronization invariant in the pegboard-runner disconnect logic. SummaryThe added comment explains why FeedbackCorrectness: The explanation is accurate and helpful. The comment correctly describes the invariant that needs to hold to avoid a race between the outgoing and incoming connections sharing a Comment style: Per CLAUDE.md conventions, comments should be written as normal, complete sentences and should avoid dashes (hyphens are OK). The added comment uses a comma to join two related ideas, which reads naturally. No issues here. Comment placement: The comment is placed at the top of the Minor suggestion: The comment could lead with the condition to mirror the symmetric // If evicted, the replacement connection already rewrote the alloc idx under the same
// runner_id. Clearing it here would race the new connection.This is purely optional — the current wording is clear. No functional, performance, or security concerns. This is a pure documentation change with no behavioral impact. Overall: looks good to merge once out of draft. |
922b64a to
f1369a5
Compare
30994fa to
8490d0e
Compare

Description
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
Type of change
How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
Checklist: