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-09-09 17:13:43 -07:00
parent e1f6007dea
commit 03f0984e1d
7 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -70,7 +70,7 @@ values are converted, and, in some cases, additional semantic context fields are
added.
To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True`
function parameter in `parse()`.
function parameter in `parse()` when using `jc` as a python library.
Schemas for each parser can be found at the documentation link beside each
[**Parser**](#parsers) below.
@ -139,11 +139,12 @@ echo STRING | jc [OPTIONS] PARSER
```
Alternatively, the "magic" syntax can be used by prepending `jc` to the command
to be converted. Options can be passed to `jc` immediately before the command is
given. (Note: command aliases and shell builtins are not supported)
to be converted or in front of the absolute path for Proc files. Options can be
passed to `jc` immediately before the command or Proc file path is given.
(Note: command aliases and shell builtins are not supported)
```bash
jc [OPTIONS] COMMAND
jc [OPTIONS] /proc/<path-to-file>
jc [OPTIONS] /proc/<path-to-procfile>
```
The JSON output can be compact (default) or pretty formatted with the `-p`

4
docs/parsers/proc_driver_rtc.md
View File

@ -29,8 +29,8 @@ or
Schema:
"yes" and "no" values are converted to true/false. Integer conversions are
attempted. If you do not want this behavior, then use `--raw` (CLI) or
"yes" and "no" values are converted to `true`/`false`. Integer conversions
are attempted. If you do not want this behavior, then use `--raw` (cli) or
`raw=True` (module).
{

2
jc/cli.py
View File

@ -195,7 +195,7 @@ Usage:
jc [OPTIONS] COMMAND
jc [OPTIONS] /proc/<path-to-file>
jc [OPTIONS] /proc/<path-to-procfile>
Parsers:
{parsers_string}

4
jc/parsers/proc_driver_rtc.py
View File

@ -24,8 +24,8 @@ or
Schema:
"yes" and "no" values are converted to true/false. Integer conversions are
attempted. If you do not want this behavior, then use `--raw` (CLI) or
"yes" and "no" values are converted to `true`/`false`. Integer conversions
are attempted. If you do not want this behavior, then use `--raw` (cli) or
`raw=True` (module).
{

2
man/jc.1
View File

@ -18,7 +18,7 @@ Magic syntax:
.RS
\fBjc\fP [OPTIONS] COMMAND
\fBjc\fP [OPTIONS] /proc/<path-to-file>
\fBjc\fP [OPTIONS] /proc/<path-to-procfile>
.RE
.SH DESCRIPTION

2
templates/manpage_template
View File

@ -18,7 +18,7 @@ Magic syntax:
.RS
\fBjc\fP [OPTIONS] COMMAND
\fBjc\fP [OPTIONS] /proc/<path-to-file>
\fBjc\fP [OPTIONS] /proc/<path-to-procfile>
.RE
.SH DESCRIPTION

9
templates/readme_template
View File

@ -70,7 +70,7 @@ values are converted, and, in some cases, additional semantic context fields are
added.
To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True`
function parameter in `parse()`.
function parameter in `parse()` when using `jc` as a python library.
Schemas for each parser can be found at the documentation link beside each
[**Parser**](#parsers) below.
@ -139,11 +139,12 @@ echo STRING | jc [OPTIONS] PARSER
```
Alternatively, the "magic" syntax can be used by prepending `jc` to the command
to be converted. Options can be passed to `jc` immediately before the command is
given. (Note: command aliases and shell builtins are not supported)
to be converted or in front of the absolute path for Proc files. Options can be
passed to `jc` immediately before the command or Proc file path is given.
(Note: command aliases and shell builtins are not supported)
```bash
jc [OPTIONS] COMMAND
jc [OPTIONS] /proc/<path-to-file>
jc [OPTIONS] /proc/<path-to-procfile>
```
The JSON output can be compact (default) or pretty formatted with the `-p`