diff --git a/README.md b/README.md index 9fbc4381..f9225244 100644 --- a/README.md +++ b/README.md @@ -232,9 +232,9 @@ Most parsers load all of the data from STDIN, parse it, then output the entire J #### Ignoring Errors -You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the `-q` cli option or the `quiet=True` argument with the `parse()` function. This will add a `_meta` object to the JSON output with a `success` attribute. If `success` is `true`, then there were no issues parsing the line. If `success` is `false`, then a parsing issue was found and `error` and `line` fields will be added to include a short error description and the contents of the unparsable line, respectively: +You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the `-qq` cli option or the `ignore_exceptions=True` argument with the `parse()` function. This will add a `_meta` object to the JSON output with a `success` attribute. If `success` is `true`, then there were no issues parsing the line. If `success` is `false`, then a parsing issue was found and `error` and `line` fields will be added to include a short error description and the contents of the unparsable line, respectively: -Successfully parsed line with `-q` option: +Successfully parsed line with `-qq` option: ```json { "command_data": "data", @@ -243,7 +243,7 @@ Successfully parsed line with `-q` option: } } ``` -Unsuccessfully parsed line with `-q` option: +Unsuccessfully parsed line with `-qq` option: ```json { "_meta": { diff --git a/man/jc.1 b/man/jc.1 index 8b5ead7a..ff4a01f1 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -493,10 +493,10 @@ Note: Streaming parsers cannot be used with the "magic" syntax \fBIgnoring Errors\fP -You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the \fB-q\fP cli option or the \fBquiet=True\fP argument with the \fBparse()\fP function. This will add a \fB_meta\fP object to the JSON output with a \fBsuccess\fP attribute. If \fBsuccess\fP is \fBtrue\fP, then there were no issues parsing the line. If \fBsuccess\fP is \fBfalse\fP, then a parsing issue was found and \fBerror\fP and \fBline\fP fields will be added to include a short error description and the contents of the unparsable line, respectively: +You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the \fB-qq\fP cli option. This will add a \fB_meta\fP object to the JSON output with a \fBsuccess\fP attribute. If \fBsuccess\fP is \fBtrue\fP, then there were no issues parsing the line. If \fBsuccess\fP is \fBfalse\fP, then a parsing issue was found and \fBerror\fP and \fBline\fP fields will be added to include a short error description and the contents of the unparsable line, respectively: .RS -Successfully parsed line with \fB-q\fP option: +Successfully parsed line with \fB-qq\fP option: .RS { @@ -511,7 +511,7 @@ Successfully parsed line with \fB-q\fP option: } .RE -Unsuccessfully parsed line with \fB-q\fP option: +Unsuccessfully parsed line with \fB-qq\fP option: .RS { diff --git a/templates/manpage_template b/templates/manpage_template index 4bec0df6..31fbbf42 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -108,10 +108,10 @@ Note: Streaming parsers cannot be used with the "magic" syntax \fBIgnoring Errors\fP -You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the \fB-q\fP cli option or the \fBquiet=True\fP argument with the \fBparse()\fP function. This will add a \fB_meta\fP object to the JSON output with a \fBsuccess\fP attribute. If \fBsuccess\fP is \fBtrue\fP, then there were no issues parsing the line. If \fBsuccess\fP is \fBfalse\fP, then a parsing issue was found and \fBerror\fP and \fBline\fP fields will be added to include a short error description and the contents of the unparsable line, respectively: +You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the \fB-qq\fP cli option. This will add a \fB_meta\fP object to the JSON output with a \fBsuccess\fP attribute. If \fBsuccess\fP is \fBtrue\fP, then there were no issues parsing the line. If \fBsuccess\fP is \fBfalse\fP, then a parsing issue was found and \fBerror\fP and \fBline\fP fields will be added to include a short error description and the contents of the unparsable line, respectively: .RS -Successfully parsed line with \fB-q\fP option: +Successfully parsed line with \fB-qq\fP option: .RS { @@ -126,7 +126,7 @@ Successfully parsed line with \fB-q\fP option: } .RE -Unsuccessfully parsed line with \fB-q\fP option: +Unsuccessfully parsed line with \fB-qq\fP option: .RS { diff --git a/templates/readme_template b/templates/readme_template index f0a099b9..0e3397e3 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -155,9 +155,9 @@ Most parsers load all of the data from STDIN, parse it, then output the entire J #### Ignoring Errors -You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the `-q` cli option or the `quiet=True` argument with the `parse()` function. This will add a `_meta` object to the JSON output with a `success` attribute. If `success` is `true`, then there were no issues parsing the line. If `success` is `false`, then a parsing issue was found and `error` and `line` fields will be added to include a short error description and the contents of the unparsable line, respectively: +You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the `-qq` cli option or the `ignore_exceptions=True` argument with the `parse()` function. This will add a `_meta` object to the JSON output with a `success` attribute. If `success` is `true`, then there were no issues parsing the line. If `success` is `false`, then a parsing issue was found and `error` and `line` fields will be added to include a short error description and the contents of the unparsable line, respectively: -Successfully parsed line with `-q` option: +Successfully parsed line with `-qq` option: ```json { "command_data": "data", @@ -166,7 +166,7 @@ Successfully parsed line with `-q` option: } } ``` -Unsuccessfully parsed line with `-q` option: +Unsuccessfully parsed line with `-qq` option: ```json { "_meta": {