Merge pull request #700 from epage/debug

docs(tutorial): Make some connections explicit for traces
winnow-rs · Jan 20, 2025 · 6fc1187 · 6fc1187
2 parents 5ffcd7c + 4ce70ca
commit 6fc1187
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/assets/trace.svg b/assets/trace.svg
diff --git a/src/_tutorial/chapter_8.rs b/src/_tutorial/chapter_8.rs
@@ -1,8 +1,9 @@
 //! # Chapter 8: Debugging
 //!
 //! When things inevitably go wrong, you can introspect the parsing state by running your test case
-//! with `--features winnow/debug`:
+//! with `--features winnow/debug`.
 //!
+//! For example, the trace output of an [escaped string parser][crate::_topic::language#escaped-strings]:
 //! ![Trace output from string example](https://raw.githubusercontent.com/winnow-rs/winnow/main/assets/trace.svg "Example output")
 //!
 //! You can extend your own parsers to show up by wrapping their body with

diff --git a/src/combinator/debug/mod.rs b/src/combinator/debug/mod.rs
@@ -92,5 +92,5 @@ fn example() {
             .with_current_dir(current_dir)
             .with_env("CLICOLOR_FORCE", "1"),
     )
-    .test("assets/trace.svg", [cmd.as_str()]);
+    .test("assets/trace.svg", [format!(r#"{cmd} '"abc"'"#).as_str()]);
 }