chore: remove private-spec section references from code comments#20
Merged
Conversation
The spec is a private doc that is never pushed, so its section and build-slice numbers are meaningless to a public reader and hint at an unshared document. Strip every '(Section N)', '(spec 6.3)', and 'Slice N' reference across src and test, keeping the explanatory prose. Where a pointer was doing real work it is replaced with plain language (e.g. 'deferred to Section 4' becomes 'handled by the safety layer'). Comments only, no logic change. 166 tests green, fmt clean.
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.
The design spec is a private document that is never pushed publicly, so the
(Section N),(spec 6.3), andSlice Nreferences scattered through the code point at something no external reader can see, and they hint at an unshared doc.This strips all 20 of them across
src/andtest/, keeping the explanatory prose that carries the actual rationale. Where a pointer was doing real work in a sentence, it is replaced with plain language, for example "the quarantine case deferred to Section 4" becomes "the quarantine case handled by the safety layer," and the test@noticeheaders that read "Section 4 Slice 3:" keep their description without the private numbering.Comments only, no logic change. Same scrub as the earlier cross-reference cleanup, applied to everything added since. 166 tests green,
forge fmtclean.