fix(sdk): correct jsdoc indent
Issue:
The documentation for jsdoc says there should be one space on each new line, currently there is none. The eslint-disable doesn't work (doesn't miss the error) because the jsdoc is added above.
Solution:
Fix the jsdoc by adding spaces
📝 Walkthrough
Walkthrough
The change updates the formatting of the comment block at the top of the generated source file in packages/sdk/src/code-gen.ts. The modification adjusts the alignment and spacing of the asterisk lines within the comment, ensuring consistent indentation and style. No logic, functionality, or exported entities are affected by this change.
Changes
| File(s) | Change Summary |
|---|---|
| packages/sdk/src/code-gen.ts | Reformatted the comment block at the top of the generated source file for improved alignment and consistent indentation. No logic or control flow changes. |
Possibly related PRs
- zenstackhq/zenstack#1900: Both PRs modify the comment header in the generated source file within
packages/sdk/src/code-gen.ts, focusing on formatting and content of the generation notice without changing logic or exported entities.
📜 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 88f8c770917afca4a5a0f498247d5034f587f00f and 30ffc29bce4627bc70ab1ca5d46299cf4c1ef959.
📒 Files selected for processing (1)
packages/sdk/src/code-gen.ts(1 hunks)
🔇 Additional comments (1)
packages/sdk/src/code-gen.ts (1)
26-27: Proper JSDoc indentation applied
The added leading space before each*now aligns with the JSDoc style guide, ensuring the comment block is correctly terminated and that the subsequent/* eslint-disable */directive takes effect as intended.
✨ 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.
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
‼️ IMPORTANT Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
Good catch! Thanks for making the fix @DoctorFTB !