Change doc for email validation method in Zod schema

[szmazhr]

No description provided.

[coderabbitai]

Walkthrough

The change updates documentation in the zod package by replacing an email validation example. The example switches from using email() method chained on a string schema to using Zod's dedicated z.email() primitive type. This is purely a documentation update with no changes to exported or public declarations.

Pre-merge checks

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Description Check	❓ Inconclusive	No description was provided by the author, making it impossible to evaluate whether the description relates to the changeset as the check requires. While the PR is small in scope (a single documentation file), the complete absence of descriptive text means we can't properly assess this criterion.	Consider adding a brief description explaining why this documentation change improves the email validation example, even if it's just a sentence or two. This would help reviewers understand the motivation behind the update.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "Change doc for email validation method in Zod schema" accurately reflects the main change—updating documentation to use the dedicated z.email() primitive instead of email() on a string schema. The title is concise and specific enough to clearly communicate the purpose of the change to anyone reviewing PR history.

---

📜 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 8d336c4 and b3fd245.

📒 Files selected for processing (1)

• packages/docs/content/packages/zod.mdx (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: CR
PR: colinhacks/zod#0
File: .cursor/rules/zod-project-guide.mdc:0-0
Timestamp: 2025-10-21T17:28:01.210Z
Learning: Applies to packages/zod/** : Make core Zod library changes in the main package at packages/zod/

Learnt from: CR
PR: colinhacks/zod#0
File: .cursor/rules/testing-guidelines.mdc:0-0
Timestamp: 2025-10-21T17:26:08.288Z
Learning: Applies to packages/zod/src/{v4/classic/tests,v4/core/tests,v3/tests}/**/*.test.ts : Import Zod in tests as `import * as z from "zod/v4"`

Learnt from: CR
PR: colinhacks/zod#0
File: .cursor/rules/zod-internals.mdc:0-0
Timestamp: 2025-10-21T17:27:32.492Z
Learning: Applies to packages/zod/src/v4/core/{schemas.ts,core.ts} : Use the custom constructor system via core.$constructor() and initialize instances with $ZodType.init() when creating schemas

📚 Learning: 2025-10-21T17:28:01.210Z

Learnt from: CR
PR: colinhacks/zod#0
File: .cursor/rules/zod-project-guide.mdc:0-0
Timestamp: 2025-10-21T17:28:01.210Z
Learning: Applies to packages/zod/** : Make core Zod library changes in the main package at packages/zod/

Applied to files:

• packages/docs/content/packages/zod.mdx

📚 Learning: 2025-10-21T17:27:32.492Z

Learnt from: CR
PR: colinhacks/zod#0
File: .cursor/rules/zod-internals.mdc:0-0
Timestamp: 2025-10-21T17:27:32.492Z
Learning: Applies to packages/zod/src/v4/core/{schemas.ts,core.ts} : Use the custom constructor system via core.$constructor() and initialize instances with $ZodType.init() when creating schemas

Applied to files:

• packages/docs/content/packages/zod.mdx

🔇 Additional comments (1)

packages/docs/content/packages/zod.mdx (1)

18-18: Nice documentation improvement!

Switching from the chained .email() on a string schema to the dedicated z.email() primitive is cleaner and shows developers the more idiomatic approach right off the bat. This is a solid docs update.

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}