From f64ef1a7d7836ee60fb277d49302661af630d6c1 Mon Sep 17 00:00:00 2001
From: Nicolas Williams <nico@cryptonector.com>
Date: Sun, 23 Jul 2023 00:01:52 -0500
Subject: Fix --stream-errors w/o --stream, and doc+test (close #2748)

---
 docs/content/manual/manual.yml | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'docs')

diff --git a/docs/content/manual/manual.yml b/docs/content/manual/manual.yml
index 6568ec1e..157bdc42 100644
--- a/docs/content/manual/manual.yml
+++ b/docs/content/manual/manual.yml
@@ -130,6 +130,16 @@ sections:
         conjunction with filtering and the `reduce` and `foreach` syntax
         to reduce large inputs incrementally.
 
+      * `--stream-errors`:
+
+        Like `--stream`, but invalid JSON inputs yield array calues
+        where the first element is the error and the second is a path.
+        For example, `["a",n]` produces ["Invalid literal at line 1,
+        column 9",[1]]`.
+
+        Implies `--stream`.  Invalid JSON inputs produce no error values
+        when `--stream` without `--stream-errors`.
+
       * `--slurp`/`-s`:
 
         Instead of running the filter for each JSON object in the
-- 
cgit v1.2.3