mirror of
https://github.com/kellyjonbrazil/jc.git
synced 2025-07-13 01:20:24 +02:00
change error_msg to error in -q result docs
This commit is contained in:
@ -38,7 +38,7 @@ Schema:
|
|||||||
"_meta": # This object only exists if using -q or quiet=True
|
"_meta": # This object only exists if using -q or quiet=True
|
||||||
{
|
{
|
||||||
"success": booean, # true if successfully parsed, false if error
|
"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
|
"line": string # exists if "success" is false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -21,7 +21,7 @@ Schema:
|
|||||||
"_meta": # This object only exists if using -q or quiet=True
|
"_meta": # This object only exists if using -q or quiet=True
|
||||||
{
|
{
|
||||||
"success": booean, # true if successfully parsed, false if error
|
"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
|
"line": string # exists if "success" is false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -117,6 +117,12 @@ Returns:
|
|||||||
True/False False unless a 'truthy' number or string is found ('y', 'yes', 'true', '1', 1, -1, etc.)
|
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
|
## stream_error
|
||||||
```python
|
```python
|
||||||
stream_error(e, quiet, line)
|
stream_error(e, quiet, line)
|
||||||
|
@ -18,7 +18,7 @@ Schema:
|
|||||||
"_meta": # This object only exists if using -q or quiet=True
|
"_meta": # This object only exists if using -q or quiet=True
|
||||||
{
|
{
|
||||||
"success": booean, # true if successfully parsed, false if error
|
"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
|
"line": string # exists if "success" is false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -35,7 +35,7 @@ Schema:
|
|||||||
"_meta": # This object only exists if using -q or quiet=True
|
"_meta": # This object only exists if using -q or quiet=True
|
||||||
{
|
{
|
||||||
"success": booean, # true if successfully parsed, false if error
|
"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
|
"line": string # exists if "success" is false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -18,7 +18,7 @@ Schema:
|
|||||||
"_meta": # This object only exists if using -q or quiet=True
|
"_meta": # This object only exists if using -q or quiet=True
|
||||||
{
|
{
|
||||||
"success": booean, # true if successfully parsed, false if error
|
"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
|
"line": string # exists if "success" is false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
2
man/jc.1
2
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
|
.SH NAME
|
||||||
jc \- JSONifies the output of many CLI tools and file-types
|
jc \- JSONifies the output of many CLI tools and file-types
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
Reference in New Issue
Block a user