-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
chore: fix comment for packages/docs/content/v4/index.mdx #4533
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: tongjicoder <[email protected]>
WalkthroughThis update corrects a typographical error in the documentation by changing "it it considered stable" to "it is considered stable" in the Versioning section. No code or logic was modified—only the docs were touched. Changes
Possibly related PRs
Poem
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
packages/docs/content/v4/index.mdx
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/docs/content/v4/index.mdx
[grammar] ~17-~17: The modal verb ‘will’ requires the verb’s base form.
Context: ...ociated libraries, Zod 4 will initially published alongside Zod 3 as part of the `[email protected]...
(MD_BASEFORM)
@@ -14,7 +14,7 @@ Huge thanks to [Clerk](https://go.clerk.com/zod-clerk), who supported my work on | |||
|
|||
## Versioning | |||
|
|||
To simplify the migration process both for users and Zod's ecosystem of associated libraries, Zod 4 will initially published alongside Zod 3 as part of the `[email protected]` release. Despite the version number, it it considered stable and ready for production use. | |||
To simplify the migration process both for users and Zod's ecosystem of associated libraries, Zod 4 will initially published alongside Zod 3 as part of the `[email protected]` release. Despite the version number, it is considered stable and ready for production use. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Fix typo and tighten up the grammar.
Nice catch changing “it it” to “it is”! While you’re here, we can also smooth out the passive clause:
-Zod 4 will initially published alongside Zod 3 as part of the `[email protected]` release. Despite the version number, it is considered stable and ready for production use.
+Zod 4 will be initially published alongside Zod 3 as part of the `[email protected]` release. Despite the version number, it is considered stable and ready for production use.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
To simplify the migration process both for users and Zod's ecosystem of associated libraries, Zod 4 will initially published alongside Zod 3 as part of the `[email protected]` release. Despite the version number, it is considered stable and ready for production use. | |
To simplify the migration process both for users and Zod's ecosystem of associated libraries, Zod 4 will be initially published alongside Zod 3 as part of the `[email protected]` release. Despite the version number, it is considered stable and ready for production use. |
🧰 Tools
🪛 LanguageTool
[grammar] ~17-~17: The modal verb ‘will’ requires the verb’s base form.
Context: ...ociated libraries, Zod 4 will initially published alongside Zod 3 as part of the `[email protected]...
(MD_BASEFORM)
🤖 Prompt for AI Agents
In packages/docs/content/v4/index.mdx at line 17, fix the typo "initially
published" by adding the missing word "be" to read "will initially be
published." Also, rephrase the sentence to remove the passive voice and improve
grammar for smoother readability, such as changing "it is considered stable" to
a more active construction.
Thanks! |
documentation improvements: fix comment for packages/docs/content/v4/index.mdx
Summary by CodeRabbit