Repository navigation
docs(standard): state the tombstone projection rule correctly - #140
Merged
Merged
Conversation
Specification §11 and two matching comments claimed that a `withdrawn`
or `blocked` record is additionally excluded from `Work` mapping
projections. The compiler excludes all three retired statuses:
`RETIRED_STATUSES` is `{deprecated, withdrawn, blocked}` and the
projection skips every one of them.
The two halves of the sentence were attached to the wrong statuses. The
projection rule covers all three. The additional rule for `withdrawn`
and `blocked` is a different one: a live record may not depend on them,
which the compiler enforces through `TOMBSTONE_STATUSES`.
§6 already stated the projection rule correctly, so the specification
contradicted itself. The comments cited `RETIRED_STATUSES` as agreeing
with them while that constant said the opposite.
No test is added. `scripts/compile.test.ts` already asserts that a
deprecated mapping leaves the projection, so the behaviour was correct
and covered; only the prose was wrong. The comments now point at it.
Closes textrefs#132
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011HLhfpsrWxq56jnZr1gD8B
There was a problem hiding this comment.
🟢 Approval recommended
The changes are documentation/comment-only and are consistent with the compiler constants and existing tests that already cover the behavior.
Pull request overview
This PR fixes an internal inconsistency in the TextRefs standard documentation and related UI-code comments by stating the tombstone projection vs. dependency rules in a way that matches the compiler’s actual behavior.
Changes:
- Corrects Specification §11’s description of how
deprecated/withdrawn/blockedaffectWorkmapping projections. - Updates tombstone explanatory comments in the tombstone banner component and the
/id/ref/{uuid}page to align withRETIRED_STATUSESandTOMBSTONE_STATUSES. - Points prose/comments at existing tests rather than restating behavioral claims inconsistently.
File summaries
| File | Description |
|---|---|
| src/pages/id/ref/[uuid]/index.astro | Updates tombstone explanatory comment to match compiler rules (projection exclusion for all three; dependency rule for withdrawn/blocked). |
| src/content/docs/standard/specification.md | Fixes §11 tombstone rule prose to consistently reflect compiler behavior and §6. |
| src/components/Tombstone.astro | Updates shared tombstone explanatory comment used by the tombstone banner component. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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 bug
Specification §11 and two matching code comments claimed:
The compiler excludes all three.
RETIRED_STATUSESis{deprecated, withdrawn, blocked}(scripts/compile.ts:641) and the projection loop skips every one of them (:493).§6 already stated this correctly, so the specification contradicted itself. Both comments cited
RETIRED_STATUSESas agreeing with them, while that constant said the opposite.What the real difference is
The two halves of the sentence were attached to the wrong statuses.
Workmapping projectionsdeprecated,withdrawn,blockedRETIRED_STATUSES,compile.ts:493withdrawn,blockedTOMBSTONE_STATUSES,compile.ts:678So the projection rule covers all three, and the additional rule for
withdrawnandblockedis the dependency rule, not the projection one. §11 now says exactly that, in the same three places.No test
scripts/compile.test.tsalready carriesdeprecated mappings are excluded from the projection, and it has been passing throughout. The behaviour was correct and covered; only the prose was wrong. The comments now point at that test rather than duplicating it.Not changed
The user-visible tombstone banner. It says a deprecated record "is retained and it still resolves", which is true, and it never mentions mapping projections.
Verification
npm run verify— 118 tests pass, 259,812 pages built, all internal links validCloses #132
🤖 Generated with Claude Code
https://claude.ai/code/session_011HLhfpsrWxq56jnZr1gD8B