docs: improve jsdoc for custom implementation of EdgeStyle

[tbouffard]

Do not declare custom implementation in EdgeStyle. This cause type issues with TypeScript and will reduce tree-shaking
optimization in the future.

Summary by CodeRabbit

• Documentation
  • Streamlined the examples and guidance for using custom edge styles with a simplified naming convention, eliminating unnecessary prefixes.

[coderabbitai]

Walkthrough

The pull request updates the documentation within the EdgeStyle.ts file to simplify the naming conventions for custom edge styles. The examples in the comments have been modified to remove the redundant 'EdgeStyle.' prefix, using just the style name (e.g., 'MyStyle') consistently. There are no changes to the exported entities or any alterations to the control flow.

Changes

File	Change Summary
packages/core/src/.../EdgeStyle.ts	Updated documentation comments and examples by removing the 'EdgeStyle.' prefix from custom edge style names, ensuring consistent usage.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1253ea9 and 96420b0.

📒 Files selected for processing (1)

• packages/core/src/view/style/EdgeStyle.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build (windows-2022)

🔇 Additional comments (3)

packages/core/src/view/style/EdgeStyle.ts (3)

67-68: LGTM! Documentation clarification improves TypeScript compatibility.

The removal of the 'EdgeStyle.' prefix in the example makes it clearer that custom implementations should not be declared in EdgeStyle. This aligns with the PR objectives to address TypeScript type issues and enhance tree-shaking optimization.

---

74-74: Good improvement to the example code.

This change consistently applies the simplified naming convention for custom edge styles. By using just MyStyle instead of EdgeStyle.MyStyle, the documentation now better represents the recommended implementation approach.

---

79-79: LGTM! Consistent documentation update.

This change maintains consistency with the other documentation updates, ensuring a uniform approach to custom edge style naming throughout the examples.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud