docs: improve JSDoc of UndoManager by tbouffard ยท Pull Request #1007 ยท maxGraph/maxGraph
No actionable comments were generated in the recent review. ๐
Walkthrough
Comments and JSDoc in UndoManager.ts were updated to replace legacy mx-* names with current public types and event identifiers (e.g., mxUndoableChange โ UndoableEdit, mxEvent โ InternalEvent, mxGraphModel โ GraphDataModel), update change-type names, and modernize example code. No runtime logic, signatures, or exported APIs changed.
Changes
| Cohort / File(s) | Summary |
|---|---|
Documentation Updates packages/core/src/view/undoable-change/UndoManager.ts |
Rewrote comments/JSDoc to use current API names: mxUndoableChange โ UndoableEdit, mxGraphView/mxGraphModel โ GraphView/GraphDataModel, mxEvent.* โ InternalEvent.* (CLEAR, UNDO, REDO, ADD). Adjusted change-type names (RootChange, ChildChange, TerminalChange), updated payload descriptions to UndoableEdit, and modernized example code (const, standard functions) and listener binding references. All edits are comment-only; no code or signature changes. |
Estimated code review effort
๐ฏ 1 (Trivial) | โฑ๏ธ ~2 minutes
๐ฅ Pre-merge checks | โ 2 | โ 1
โ Failed checks (1 warning)
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Description check | โ ๏ธ Warning | No pull request description was provided. The template requires an Overview section explaining what and why is changed, along with PR checklist items. | Add a pull request description including: an Overview section explaining the JSDoc improvements, confirmation of relevant PR checklist items (especially whether this addresses an existing issue), and any additional notes for reviewers. |
โ Passed checks (2 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | โ Passed | The title clearly and accurately describes the main change: improving JSDoc documentation of UndoManager. It follows Conventional Commits format with 'docs' type and is concise. |
| Docstring Coverage | โ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
โ๏ธ Tip: You can configure your own custom pre-merge checks in the settings.
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.