From 84020bc2af294cb065105f1399453aefc98eb180 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Fri, 17 Sep 2021 10:26:47 -0700 Subject: [PATCH] change error_msg to error in -q result docs --- docs/parsers/ls_s.md | 2 +- docs/parsers/ping_s.md | 2 +- docs/utils.md | 6 ++++++ jc/parsers/foo_s.py | 2 +- jc/parsers/ls_s.py | 2 +- jc/parsers/ping_s.py | 2 +- man/jc.1 | 2 +- 7 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index 3f1aa87e..a38eafc0 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -38,7 +38,7 @@ Schema: "_meta": # This object only exists if using -q or quiet=True { "success": booean, # true if successfully parsed, false if error - "error_msg": string, # exists if "success" is false + "error": string, # exists if "success" is false "line": string # exists if "success" is false } } diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index d75c0372..0724b4ea 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -21,7 +21,7 @@ Schema: "_meta": # This object only exists if using -q or quiet=True { "success": booean, # true if successfully parsed, false if error - "error_msg": string, # exists if "success" is false + "error": string, # exists if "success" is false "line": string # exists if "success" is false } } diff --git a/docs/utils.md b/docs/utils.md index 1e9c57fe..50e387b0 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -117,6 +117,12 @@ Returns: True/False False unless a 'truthy' number or string is found ('y', 'yes', 'true', '1', 1, -1, etc.) +## stream_success +```python +stream_success(output_line, quiet) +``` +add _meta object to output line if -q (quiet) option is used + ## stream_error ```python stream_error(e, quiet, line) diff --git a/jc/parsers/foo_s.py b/jc/parsers/foo_s.py index 7d9e772a..7e79d085 100644 --- a/jc/parsers/foo_s.py +++ b/jc/parsers/foo_s.py @@ -18,7 +18,7 @@ Schema: "_meta": # This object only exists if using -q or quiet=True { "success": booean, # true if successfully parsed, false if error - "error_msg": string, # exists if "success" is false + "error": string, # exists if "success" is false "line": string # exists if "success" is false } } diff --git a/jc/parsers/ls_s.py b/jc/parsers/ls_s.py index d230e924..ac1a6fbb 100644 --- a/jc/parsers/ls_s.py +++ b/jc/parsers/ls_s.py @@ -35,7 +35,7 @@ Schema: "_meta": # This object only exists if using -q or quiet=True { "success": booean, # true if successfully parsed, false if error - "error_msg": string, # exists if "success" is false + "error": string, # exists if "success" is false "line": string # exists if "success" is false } } diff --git a/jc/parsers/ping_s.py b/jc/parsers/ping_s.py index 24400dff..b4ed3bf2 100644 --- a/jc/parsers/ping_s.py +++ b/jc/parsers/ping_s.py @@ -18,7 +18,7 @@ Schema: "_meta": # This object only exists if using -q or quiet=True { "success": booean, # true if successfully parsed, false if error - "error_msg": string, # exists if "success" is false + "error": string, # exists if "success" is false "line": string # exists if "success" is false } } diff --git a/man/jc.1 b/man/jc.1 index 76e5d043..5543eeb9 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2021-09-16 1.17.0 "JSON CLI output utility" +.TH jc 1 2021-09-17 1.17.0 "JSON CLI output utility" .SH NAME jc \- JSONifies the output of many CLI tools and file-types .SH SYNOPSIS