docs(source): promote Begin's sole-settle-path and panic rules to primary doc positions - #210
Merged
Merged
Conversation
… primary doc positions Gate rerun 7 found that the Begin-then-Settle disposition and fn-panic semantics — already defined since the earlier gate rounds — sat in a poison-handling paragraph reviewers consistently missed. This promotes both rules into Begin's opening paragraph, cross-references the rule from inlet.go's Settle doc, documents SeekToCursor's re-delivery convention (cursor offset onward) in the README, and adds Reject/Skip rows to the README ack-model table.
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
1 participant
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.
Checkpoint 4.9 — gate rerun-7 discoverability fixes
Gate rerun 7: 20 HELD / 0 BROKEN / 2 UNDOCUMENTED. Both UNDOCUMENTED rows (Begin±Settle disposition; fn-panic semantics) were already defined in
capability.go(lines 429/432, verified by grep against the merged tree) but placed in a poison-handling paragraph two separate reviewer passes skimmed past. A contract readers can't find is effectively absent — so this promotes the substance:Begin's opening paragraph now leads with: Begin replaces Settle for m entirely; direct Settle around Begin = caller error, undefined results (duplicate mark at best, End race at worst); fn must not panic (unrecovered propagation leaves the txn open until End/session-close/rebalance fence).inlet.goSettle doc cross-references that rule for transactional messages.SeekToCursorconvention (re-delivers from the cursor's own offset onward) +Reject/Skiprows added to the ack-model table.Docs-only; full panel reruns on this merge as the release clearance.