docs: improve jsdoc of CellOverlay #846
Conversation
Improve class and constructor docs.
WalkthroughThe JSDoc comments for the Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation updates. Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
npm error Exit handler never called! 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/core/src/view/cell/CellOverlay.ts (2)
27-63: Fix pluralization in example description
There's a minor grammatical issue in the Example section:
Line 42 reads "adds a new overlays" but should be singular.Apply this diff:
- * The following adds a new overlays for a given vertex and selects the cell if the overlay is clicked. + * The following adds a new overlay for a given vertex and selects the cell if the overlay is clicked.
65-73: Enhance constructor JSDoc param descriptions
The@param offsetand@param cursortags lack type info and descriptions, and theimageparam should referenceImageBox.Apply this diff:
- * @param image {@link Image} that represents the icon to be displayed. + * @param image {@link ImageBox} that represents the icon to be displayed. - * @param offset - * @param cursor + * @param offset {Point} Optional offset for positioning the overlay relative to its alignment. Scaled according to the current graph scale. Default is `new Point()`. + * @param cursor {string} Optional CSS cursor for the overlay. Default is `'help'`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/core/src/view/cell/CellOverlay.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: build (ubuntu-22.04)
- GitHub Check: build (macos-14)
- GitHub Check: build
- GitHub Check: build (windows-2022)
|
1 participant
Improve class and constructor docs.
Summary by CodeRabbit