revision to arrayNode.ts push API documentation #26329
Merged
+5
−2
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation of the push API in arrayNode.ts to provide more specific clarification about the concurrency semantics for concurrent insertions. The previous documentation vaguely stated that "merge semantics for concurrent inserts or moves to the same position are unspecified," which has been replaced with detailed examples explaining the partially-specified behavior.
Changes:
- Enhanced the
pushmethod documentation with specific examples of concurrent insertion behavior - Clarified that concurrent insertions won't interleave, providing clear examples with
[A, B]and[X, Y]arrays
packages/dds/tree/src/simple-tree/node-kinds/array/arrayNode.ts
Outdated
Show resolved
Hide resolved
noencke
reviewed
Jan 30, 2026
packages/dds/tree/src/simple-tree/node-kinds/array/arrayNode.ts
Outdated
Show resolved
Hide resolved
noencke
approved these changes
Jan 30, 2026
yann-achard-MS
approved these changes
Jan 30, 2026
noencke
approved these changes
Jan 30, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
The documentation of the
pushAPI inarrayNode.tscould cause confusion on what is unspecified by the API. Documentation has been updated to be specific as to what is unspecified.