docs: registry/storage accuracy notes + surface-freeze checklist step#412
Merged
Conversation
Contributor
|
|
commit: |
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.
What
Documentation-accuracy fixes, each confirmed against source — no behavior changes (
docs).RegistryTicket.indexJSDoc) — notes the lazy-reindex contract: a ticket read viavalues()/entries()immediately afterunregister()/offboard()may carry a staleindexuntil the next position-reading call (register/upsert/browse/lookup/move/reorder/seek) drains the deferred reindex.StorageContext.remove/clearJSDoc) — tightened to reflect actual scope: they act on keys accessed through this storage instance; keys persisted by a previous session but never read here are not removed. Drops the "all keys from storage" overstatement.unregisteris an O(n) locate+splice), so batch removals viaoffboard/clearand bound the mounted/registered count with createVirtual for large lists.packages/0/src/surface.test.ts(the public-surface freeze test) when a new public export is added — both tables + the bottom checklist.Verification
pnpm typecheck:0+pnpm build:docs— both green.