docs(HiearchicalLayout): fix copy pasted JSDoc for cache attributes by le-codeur-rapide ยท Pull Request #975 ยท maxGraph/maxGraph

Walkthrough

Clarified JSDoc comments for three internal caches in HierarchicalLayout and removed an unused local destructuring in the getEdges method; no behavior or exported API changes.

Changes

Cohort / File(s) Change Summary
Documentation & cleanup
packages/core/src/view/layout/HierarchicalLayout.ts
Updated JSDoc for edgesCache, edgeSourceTermCache, and edgesTargetTermCache to accurately describe their mappings; removed an unused const { model } = this.graph destructuring in getEdges.

Estimated code review effort

๐ŸŽฏ 1 (Trivial) | โฑ๏ธ ~3 minutes

Pre-merge checks and finishing touches

โœ… Passed checks (3 passed)
Check name Status Explanation
Title check โœ… Passed The title accurately describes the main change: fixing copy-pasted JSDoc documentation for cache attributes in HierarchicalLayout, and follows Conventional Commits format.
Description check โœ… Passed The description is minimal but adequate for a small documentation fix. It clearly explains what was changed (JSDoc for three cache attributes and an unused variable) and appropriately justifies not opening a separate issue.
Docstring Coverage โœ… Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
โœจ Finishing touches
  • ๐Ÿ“ Generate docstrings
๐Ÿงช Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

๐Ÿ“œ Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

๐Ÿ“ฅ Commits

Reviewing files that changed from the base of the PR and between 0612008 and eb66b6a.

๐Ÿ“’ Files selected for processing (1)
  • packages/core/src/view/layout/HierarchicalLayout.ts
๐Ÿšง Files skipped from review as they are similar to previous changes (1)
  • packages/core/src/view/layout/HierarchicalLayout.ts

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.