From b689e34418e3d09d8274bf5355e007236f719e8b Mon Sep 17 00:00:00 2001 From: Yury Fedotov <102987839+yury-fedotov@users.noreply.github.com> Date: Sun, 16 Mar 2025 10:26:33 -0400 Subject: [PATCH] Fix 2 typos in MRE docs (#12198) 2 fixes: 1. `examaple` -> `example`. 2. `"Any relevant system state (e.g., )"` was missing the part after `"e.g.,"`, so I'm adding an example there. --- docs/reference/troubleshooting/reproducible-examples.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/troubleshooting/reproducible-examples.md b/docs/reference/troubleshooting/reproducible-examples.md index b21b9c0f7..0f2044305 100644 --- a/docs/reference/troubleshooting/reproducible-examples.md +++ b/docs/reference/troubleshooting/reproducible-examples.md @@ -9,11 +9,11 @@ a maintainer much longer to identify the root cause of the problem. ## How to write a reproducible example -When writing a reproducible examaple, the goal is to provide all of the context necessary for -someone else to reproduce your example. This includes: +When writing a reproducible example, the goal is to provide all of the context necessary for someone +else to reproduce your example. This includes: - The platform you're using (e.g., the operating system and architecture) -- Any relevant system state (e.g., ) +- Any relevant system state (e.g., explicitly set environment variables) - The version of uv - The version of other relevant tools - The relevant files (the `uv.lock`, `pyproject.toml`, etc.)