docs(tree): tweaks to constraint docs#27309
Conversation
|
Hi! Thank you for opening this PR. Want me to review it? Based on the diff (25 lines, 2 files), I've queued these reviewers:
How this works
|
There was a problem hiding this comment.
Pull request overview
Tweaks SharedTree transaction constraint documentation (follow-up to #26763) to better explain when constraints are evaluated and to clarify the intended semantics of the noChange constraint, plus a small related comment update in delta utilities.
Changes:
- Add a note explaining how/when constraint violations are settled across clients (optimistic local application vs. post-sequencing reconciliation).
- Refine
noChangeconstraint documentation to emphasize whole-document equality and describe “canceling out” concurrent edits. - Update
deltaUtildoc comments to describe “visible changes” in terms of attach/detach.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/dds/tree/src/core/tree/deltaUtil.ts | Updates JSDoc wording for “visible changes” detection helpers. |
| docs/docs/data-structures/tree/transactions.mdx | Expands constraint timing explanation; refines noChange constraint docs and examples. |
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Description
Tweaks to constraint docs in the follow up to #26763.
Breaking Changes
None