docs: error message example in README doesn't match actual output #6589

Activity

1. pullfrog commented on Sep 11, 2026

   

   pullfrogBot

   on Sep 11, 2026 – with Pullfrog

   Last edited by pullfrog

   Contributor

   More actions

   good-idea — the report is correct and actionable. I reproduced the mismatch against both current main and published zod@4.6.2; the similarity candidates concern different error-reporting behavior, so this is not a duplicate.

   import * as z from "zod";
   
   const Player = z.object({
     username: z.string(),
     xp: z.number(),
   });
   
   const result = Player.safeParse({ username: 42, xp: "100" });
   if (!result.success) {
     result.error.issues.map((issue) => issue.message);
     // actual: [
     //   "Invalid input: expected string, received number",
     //   "Invalid input: expected number, received string",
     // ]
     // README currently omits both `, received …` suffixes.
   }

   Plan:

   1. Update the two message strings in packages/zod/README.md so they include , received number and , received string. The root README.md is a symlink to this file, so no second edit is needed.
   2. Rerun the exact example against current source and compare the documented issue objects with the runtime output. This is documentation-only, and the repository does not execute README code blocks, so no implementation or test-suite changes are needed.

   No implementation was started. The detailed triage record is in .triage/issues/6589/results.md.

     ^{｜ Implement plan ➔ ｜ View workflow run ｜ via Pullfrog ｜ Using GPT Sol ｜ 𝕏}
2. colinhacks

   closed this as completedin 46da957on Sep 11, 2026
3. colinhacks commented on Sep 11, 2026

   

   colinhacks

   on Sep 11, 2026

   Owner

   More actions

   Good catch. Fixed in 46da957.

   The same stale strings were on the Basics docs page too, and the Zod Mini tab needed a different value again — @zod/mini ships without the en locale, so it emits a bare Invalid input until you configure one. Six occurrences in total, so I took it directly rather than have you chase them all down.

   Thanks for the report! 👍
4. pull

   added a commit that references this issue on Sep 11, 2026

   docs: match the error-message examples to what the parsers emit

   ...

   This issue will close once commit 46da957 is merged into the 'main' branch.

   46da957