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.

โค๏ธ Share

Comment @coderabbitai help to get the list of available commands and usage tips.