python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Code Issues Releases Activity

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2022-07-23 10:45:11 -07:00
parent cd293d4786
commit 8ada8b79c1
3 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/parsers/email_address.md
View File

@ -7,7 +7,7 @@ jc - JSON Convert Email Address string parser
Usage (cli): Usage (cli):
$ echo "johndoe@example.com" | jc --email-address $ echo "username@example.com" | jc --email-address
Usage (module): Usage (module):
@ -17,9 +17,9 @@ Usage (module):
Schema: Schema:
{ {
"username": string,
"domain": string, "domain": string,
"local": string, "local": string,
"local_plus_prefix": string or null,
"local_plus_suffix": string or null "local_plus_suffix": string or null
} }
@ -27,17 +27,17 @@ Examples:
$ echo 'joe.user@gmail.com' | jc --email-address -p $ echo 'joe.user@gmail.com' | jc --email-address -p
{ {
"username": "joe.user",
"domain": "gmail.com", "domain": "gmail.com",
"local": "joe.user", "local": "joe.user",
"local_plus_prefix": null,
"local_plus_suffix": null "local_plus_suffix": null
} }
$ echo 'joe.user+spam@gmail.com' | jc --email-address -p $ echo 'joe.user+spam@gmail.com' | jc --email-address -p
{ {
"username": "joe.user",
"domain": "gmail.com", "domain": "gmail.com",
"local": "joe.user+spam", "local": "joe.user+spam",
"local_plus_prefix": "joe.user",
"local_plus_suffix": "spam" "local_plus_suffix": "spam"
} }

6
docs/parsers/url.md
View File

@ -32,7 +32,7 @@ Schema:
{ {
"url": string, "url": string,
"scheme": string, "scheme": string or null,
"netloc": string or null, "netloc": string or null,
"path": string or null, "path": string or null,
"path_list": [ array or null "path_list": [ array or null
@ -51,7 +51,7 @@ Schema:
"port": integer or null, # [1] "port": integer or null, # [1]
"encoded": { "encoded": {
"url": string, "url": string,
"scheme": string, "scheme": string or null,
"netloc": string or null, "netloc": string or null,
"path": string or null, "path": string or null,
"path_list": [ array or null "path_list": [ array or null
@ -66,7 +66,7 @@ Schema:
}, },
"decoded": { "decoded": {
"url": string, "url": string,
"scheme": string, "scheme": string or null,
"netloc": string or null, "netloc": string or null,
"path": string or null, "path": string or null,
"path_list": [ array or null "path_list": [ array or null

2
man/jc.1
View File

@ -1,4 +1,4 @@
.TH jc 1 2022-07-22 1.20.3 "JSON Convert" .TH jc 1 2022-07-23 1.20.3 "JSON Convert"
.SH NAME .SH NAME
\fBjc\fP \- JSON Convert JSONifies the output of many CLI tools and file-types \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools and file-types
.SH SYNOPSIS .SH SYNOPSIS