Better docs for IncrementalEncoderDecoder and related types#26470
Open
CraigMacomber wants to merge 4 commits intomicrosoft:mainfrom
Open
Better docs for IncrementalEncoderDecoder and related types#26470CraigMacomber wants to merge 4 commits intomicrosoft:mainfrom
CraigMacomber wants to merge 4 commits intomicrosoft:mainfrom
Conversation
CraigMacomber
commented
Feb 18, 2026
Comment on lines
106
to
108
| * Since a given Fluid summary client only ever has to complete a single summary, and that summary can only reuse content from the single summary it was loaded from, | ||
| * there is no need for implementers of this interface to support remembering chunks creating during summarization for use in future summaries. | ||
| * Future optimization or changes to Fluid's summary strategy could change this: if this occurs implementations will need to be updated accordingly. |
Contributor
Author
There was a problem hiding this comment.
I think this is true, but I need confirmation it is accurate.
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request enhances documentation for the IncrementalEncoderDecoder interface and related types in the chunked-forest codec implementation. The changes provide better context about how incremental encoding/decoding works, particularly explaining the chunk reference indirection mechanism and the Fluid summary lifecycle constraints.
Changes:
- Added detailed remarks to
ChunkReferenceIdexplaining the indirection mechanism via summary blobs and trees - Enhanced
IncrementalEncoderDecoderdocumentation to clarify chunk reuse strategy and Fluid summary client behavior - Added documentation to
FieldBatchEncodingContextexplaining the stateful nature and side effects - Removed unused runtime validator (
brandedNumberType) forChunkReferenceIdtype
packages/dds/tree/src/feature-libraries/chunked-forest/codec/codecs.ts
Outdated
Show resolved
Hide resolved
packages/dds/tree/src/feature-libraries/chunked-forest/codec/codecs.ts
Outdated
Show resolved
Hide resolved
2 tasks
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Description
Better docs for IncrementalEncoderDecoder and related types
Reviewer Guidance
The review process is outlined on this wiki page.