Fix variable name inconsistency in coercion documentation code example #5188
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses issue #5180 by fixing a variable naming inconsistency in the documentation for Zod's coercion feature. The code example in the "Customizing the input type" section had a mismatch between the variable declaration and its usage in type definitions.
The Problem
In the documentation at https://zod.dev/api?id=coercion, under the "Customizing the input type" accordion section, there was a code snippet demonstrating how to work with coercion schemas:
The variable was declared as
regularbut referenced asregularCoercein the subsequent type definitions, which would cause a TypeScript error if users copied this code directly.The Solution
This PR corrects the variable name to be consistent throughout the example:
Impact
File Changed
packages/docs/content/api.mdx(line 98)Testing
Related Issues
Fixes #5180
Additional Context
This issue was initially identified by @daniel-campbell who correctly pointed out that the variable naming was inconsistent. The fix ensures that the documentation provides accurate, copy-paste-ready code examples for users learning about Zod's coercion capabilities with custom input types.