docs(types): refresh SuperDocUI.document JSDoc to reflect dirty (SD-2667)#3043
Merged
caio-pizzol merged 1 commit intomainfrom May 1, 2026
Merged
docs(types): refresh SuperDocUI.document JSDoc to reflect dirty (SD-2667)#3043caio-pizzol merged 1 commit intomainfrom
caio-pizzol merged 1 commit intomainfrom
Conversation
…667) The JSDoc on SuperDocUI.document still claimed unsaved-changes was intentionally not on the slice. That landed in #3040 as DocumentSlice.dirty. The stale JSDoc misled at least one external reviewer into flagging the docs as documenting a non-existent field; update the JSDoc so the source is accurate.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
|
🎉 This PR is included in vscode-ext v2.3.0-next.72 |
Contributor
|
🎉 This PR is included in @superdoc-dev/mcp v0.3.0-next.27 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in @superdoc-dev/react v1.2.0-next.70 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in superdoc v1.30.0-next.29 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in superdoc-cli v0.8.0-next.45 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in superdoc-sdk v1.8.0-next.31 |
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
2 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.
The JSDoc on `SuperDocUI.document` still claimed unsaved-changes was 'intentionally not on this slice today'. That was true before #3040; `DocumentSlice.dirty` shipped in that PR. The stale JSDoc misled an external reviewer into flagging the BYO-UI docs as documenting a non-existent field. Update the JSDoc so the source matches reality.
One file, one paragraph rewrite. No runtime change.
Verified: 166/166 super-editor UI tests.