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 formatting

Browse Source
This commit is contained in:
Kelly Brazil
2022-05-28 13:13:07 -07:00
parent d3d7fbca61
commit fec74cf305
12 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/parsers/nmcli.md
View File

@ -29,14 +29,14 @@ Usage (module):
Schema:
Because there are so many options, the schema is not strictly defined.
Integer and Float value conversions are attempted and the original
values are kept if they fail. If you don't want automatic conversion,
then use the -r or raw=True option to disable it.
Because there are so many options, the schema is not strictly defined.
Integer and Float value conversions are attempted and the original
values are kept if they fail. If you don't want automatic conversion,
then use the `-r` or `raw=True` option to disable it.
The structure is flat, for the most part, but there are a couple of
"well-known" keys that are further parsed into objects for convenience.
These are documented below.
The structure is flat, for the most part, but there are a couple of
"well-known" keys that are further parsed into objects for convenience.
These are documented below.
[
{

2
docs/parsers/pidstat.md
View File

@ -3,7 +3,7 @@
# jc.parsers.pidstat
jc - JSON Convert `pidstat` command output parser
jc - JSON Convert `pidstat -h` command output parser
Must use the `-h` option in `pidstat`. All other `pidstat` options are
supported in combination with `-h`.

2
docs/parsers/pidstat_s.md
View File

@ -3,7 +3,7 @@
# jc.parsers.pidstat\_s
jc - JSON Convert `pidstat` command output streaming parser
jc - JSON Convert `pidstat -h` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns an Iterable of
> Dictionaries (module)

2
docs/parsers/rpm_qi.md
View File

@ -10,7 +10,7 @@ Works with `rpm -qi [package]` or `rpm -qia`.
The `..._epoch` calculated timestamp fields are naive. (i.e. based on the
local time of the system the parser is run on)
The `..._epoch_utc` calculated timestamp fields are timezone-aware and is
The `..._epoch_utc` calculated timestamp fields are timezone-aware and are
only available if the timezone field is UTC.
Usage (cli):

4
docs/parsers/xml.md
View File

@ -16,8 +16,8 @@ Usage (module):
Schema:
XML Document converted to a Dictionary
See https://github.com/martinblech/xmltodict for details
XML Document converted to a Dictionary. See https://github.com/martinblech/xmltodict
for details.
{
"key1": string/object,