From 29c263f87810f8566ebdad2358e99896391adfd8 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sat, 5 Mar 2022 12:15:14 -0800 Subject: [PATCH] pydoc formatting fixes --- docs/lib.md | 16 ++++++++-------- docs/parsers/acpi.md | 2 +- docs/parsers/airport.md | 2 +- docs/parsers/airport_s.md | 2 +- docs/parsers/arp.md | 2 +- docs/parsers/blkid.md | 2 +- docs/parsers/cksum.md | 2 +- docs/parsers/crontab.md | 2 +- docs/parsers/crontab_u.md | 2 +- docs/parsers/csv.md | 2 +- docs/parsers/csv_s.md | 2 +- docs/parsers/date.md | 2 +- docs/parsers/df.md | 2 +- docs/parsers/dig.md | 2 +- docs/parsers/dir.md | 2 +- docs/parsers/dmidecode.md | 2 +- docs/parsers/dpkg_l.md | 2 +- docs/parsers/du.md | 2 +- docs/parsers/env.md | 2 +- docs/parsers/file.md | 2 +- docs/parsers/finger.md | 2 +- docs/parsers/free.md | 2 +- docs/parsers/fstab.md | 2 +- docs/parsers/group.md | 2 +- docs/parsers/gshadow.md | 2 +- docs/parsers/hash.md | 2 +- docs/parsers/hashsum.md | 2 +- docs/parsers/hciconfig.md | 2 +- docs/parsers/history.md | 2 +- docs/parsers/hosts.md | 2 +- docs/parsers/id.md | 2 +- docs/parsers/ifconfig.md | 2 +- docs/parsers/ini.md | 2 +- docs/parsers/iostat.md | 2 +- docs/parsers/iostat_s.md | 2 +- docs/parsers/iptables.md | 2 +- docs/parsers/iw_scan.md | 2 +- docs/parsers/jar_manifest.md | 2 +- docs/parsers/jobs.md | 2 +- docs/parsers/kv.md | 2 +- docs/parsers/last.md | 2 +- docs/parsers/ls.md | 2 +- docs/parsers/ls_s.md | 2 +- docs/parsers/lsblk.md | 2 +- docs/parsers/lsmod.md | 2 +- docs/parsers/lsof.md | 2 +- docs/parsers/lsusb.md | 2 +- docs/parsers/mount.md | 2 +- docs/parsers/netstat.md | 2 +- docs/parsers/nmcli.md | 2 +- docs/parsers/ntpq.md | 2 +- docs/parsers/passwd.md | 2 +- docs/parsers/ping.md | 2 +- docs/parsers/ping_s.md | 2 +- docs/parsers/pip_list.md | 2 +- docs/parsers/pip_show.md | 2 +- docs/parsers/ps.md | 2 +- docs/parsers/route.md | 2 +- docs/parsers/rpm_qi.md | 2 +- docs/parsers/rsync.md | 2 +- docs/parsers/rsync_s.md | 2 +- docs/parsers/sfdisk.md | 2 +- docs/parsers/shadow.md | 2 +- docs/parsers/ss.md | 2 +- docs/parsers/stat.md | 2 +- docs/parsers/stat_s.md | 2 +- docs/parsers/sysctl.md | 2 +- docs/parsers/systemctl.md | 2 +- docs/parsers/systemctl_lj.md | 2 +- docs/parsers/systemctl_ls.md | 2 +- docs/parsers/systemctl_luf.md | 2 +- docs/parsers/systeminfo.md | 2 +- docs/parsers/time.md | 2 +- docs/parsers/timedatectl.md | 2 +- docs/parsers/tracepath.md | 2 +- docs/parsers/traceroute.md | 2 +- docs/parsers/ufw.md | 2 +- docs/parsers/ufw_appinfo.md | 2 +- docs/parsers/uname.md | 2 +- docs/parsers/universal.md | 4 ++-- docs/parsers/upower.md | 2 +- docs/parsers/uptime.md | 2 +- docs/parsers/vmstat.md | 2 +- docs/parsers/vmstat_s.md | 2 +- docs/parsers/w.md | 2 +- docs/parsers/wc.md | 2 +- docs/parsers/who.md | 2 +- docs/parsers/xml.md | 2 +- docs/parsers/xrandr.md | 2 +- docs/parsers/yaml.md | 2 +- docs/parsers/zipinfo.md | 2 +- docs/streaming.md | 12 ++++++------ docs/utils.md | 20 ++++++++++---------- 93 files changed, 115 insertions(+), 115 deletions(-) diff --git a/docs/lib.md b/docs/lib.md index 67e5ea34..ae714f9e 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -19,7 +19,7 @@ JC lib module -#### parse +### parse ```python def parse(parser_mod_name: str, @@ -86,7 +86,7 @@ Returns: -#### parser\_mod\_list +### parser\_mod\_list ```python def parser_mod_list() -> List[str] @@ -96,7 +96,7 @@ Returns a list of all available parser module names. -#### plugin\_parser\_mod\_list +### plugin\_parser\_mod\_list ```python def plugin_parser_mod_list() -> List[str] @@ -107,7 +107,7 @@ subset of `parser_mod_list()`. -#### standard\_parser\_mod\_list +### standard\_parser\_mod\_list ```python def standard_parser_mod_list() -> List[str] @@ -119,7 +119,7 @@ parsers. -#### streaming\_parser\_mod\_list +### streaming\_parser\_mod\_list ```python def streaming_parser_mod_list() -> List[str] @@ -130,7 +130,7 @@ subset of `parser_mod_list()`. -#### parser\_info +### parser\_info ```python def parser_info(parser_mod_name: str) -> Dict @@ -143,7 +143,7 @@ This function will accept **module_name**, **cli-name**, and -#### all\_parser\_info +### all\_parser\_info ```python def all_parser_info() -> List[Dict] @@ -153,7 +153,7 @@ Returns a list of dictionaries that includes metadata for all modules. -#### get\_help +### get\_help ```python def get_help(parser_mod_name: str) -> None diff --git a/docs/parsers/acpi.md b/docs/parsers/acpi.md index e486954f..98202760 100644 --- a/docs/parsers/acpi.md +++ b/docs/parsers/acpi.md @@ -234,7 +234,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/airport.md b/docs/parsers/airport.md index e9fa5490..4ec9bad3 100644 --- a/docs/parsers/airport.md +++ b/docs/parsers/airport.md @@ -87,7 +87,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/airport_s.md b/docs/parsers/airport_s.md index 84b8e4a0..b4354c45 100644 --- a/docs/parsers/airport_s.md +++ b/docs/parsers/airport_s.md @@ -115,7 +115,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/arp.md b/docs/parsers/arp.md index 136476b6..ad76015f 100644 --- a/docs/parsers/arp.md +++ b/docs/parsers/arp.md @@ -124,7 +124,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/blkid.md b/docs/parsers/blkid.md index 11f81041..09fb8abe 100644 --- a/docs/parsers/blkid.md +++ b/docs/parsers/blkid.md @@ -127,7 +127,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/cksum.md b/docs/parsers/cksum.md index aee5efc4..2ab0ecf6 100644 --- a/docs/parsers/cksum.md +++ b/docs/parsers/cksum.md @@ -61,7 +61,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/crontab.md b/docs/parsers/crontab.md index ae9c4c31..dfd27bf6 100644 --- a/docs/parsers/crontab.md +++ b/docs/parsers/crontab.md @@ -180,7 +180,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/crontab_u.md b/docs/parsers/crontab_u.md index bfcd45a6..0ae1817d 100644 --- a/docs/parsers/crontab_u.md +++ b/docs/parsers/crontab_u.md @@ -177,7 +177,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/csv.md b/docs/parsers/csv.md index d98a4945..16c65905 100644 --- a/docs/parsers/csv.md +++ b/docs/parsers/csv.md @@ -84,7 +84,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md index 902d117b..4515a77b 100644 --- a/docs/parsers/csv_s.md +++ b/docs/parsers/csv_s.md @@ -70,7 +70,7 @@ Examples: -#### parse +### parse ```python @add_jc_meta diff --git a/docs/parsers/date.md b/docs/parsers/date.md index d348d089..6da56dc5 100644 --- a/docs/parsers/date.md +++ b/docs/parsers/date.md @@ -84,7 +84,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/df.md b/docs/parsers/df.md index 25ee0773..717a9637 100644 --- a/docs/parsers/df.md +++ b/docs/parsers/df.md @@ -104,7 +104,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/dig.md b/docs/parsers/dig.md index 70bd67ea..4903fc82 100644 --- a/docs/parsers/dig.md +++ b/docs/parsers/dig.md @@ -329,7 +329,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/dir.md b/docs/parsers/dir.md index 84a76476..c04e4de6 100644 --- a/docs/parsers/dir.md +++ b/docs/parsers/dir.md @@ -127,7 +127,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/dmidecode.md b/docs/parsers/dmidecode.md index a7664b6d..8c7072ac 100644 --- a/docs/parsers/dmidecode.md +++ b/docs/parsers/dmidecode.md @@ -132,7 +132,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/dpkg_l.md b/docs/parsers/dpkg_l.md index 6b24634c..97ed8209 100644 --- a/docs/parsers/dpkg_l.md +++ b/docs/parsers/dpkg_l.md @@ -138,7 +138,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/du.md b/docs/parsers/du.md index 12ec1ca4..fe2f5511 100644 --- a/docs/parsers/du.md +++ b/docs/parsers/du.md @@ -94,7 +94,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/env.md b/docs/parsers/env.md index dd625602..1b951549 100644 --- a/docs/parsers/env.md +++ b/docs/parsers/env.md @@ -79,7 +79,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/file.md b/docs/parsers/file.md index b95f0d29..25895fe7 100644 --- a/docs/parsers/file.md +++ b/docs/parsers/file.md @@ -69,7 +69,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/finger.md b/docs/parsers/finger.md index 56daa2bc..b9445add 100644 --- a/docs/parsers/finger.md +++ b/docs/parsers/finger.md @@ -97,7 +97,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/free.md b/docs/parsers/free.md index 1b8fd722..5f540ace 100644 --- a/docs/parsers/free.md +++ b/docs/parsers/free.md @@ -79,7 +79,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/fstab.md b/docs/parsers/fstab.md index 5f4a2773..60c6555e 100644 --- a/docs/parsers/fstab.md +++ b/docs/parsers/fstab.md @@ -92,7 +92,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/group.md b/docs/parsers/group.md index 0e3fb442..33ca0cdf 100644 --- a/docs/parsers/group.md +++ b/docs/parsers/group.md @@ -116,7 +116,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/gshadow.md b/docs/parsers/gshadow.md index 1a1b7a70..e48012f9 100644 --- a/docs/parsers/gshadow.md +++ b/docs/parsers/gshadow.md @@ -84,7 +84,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/hash.md b/docs/parsers/hash.md index ca6109e0..74cde8f5 100644 --- a/docs/parsers/hash.md +++ b/docs/parsers/hash.md @@ -44,7 +44,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/hashsum.md b/docs/parsers/hashsum.md index 984babe3..b8b76634 100644 --- a/docs/parsers/hashsum.md +++ b/docs/parsers/hashsum.md @@ -75,7 +75,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/hciconfig.md b/docs/parsers/hciconfig.md index 9fe21dcb..240cc50c 100644 --- a/docs/parsers/hciconfig.md +++ b/docs/parsers/hciconfig.md @@ -324,7 +324,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/history.md b/docs/parsers/history.md index 19b5be41..5edd0ce6 100644 --- a/docs/parsers/history.md +++ b/docs/parsers/history.md @@ -70,7 +70,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/hosts.md b/docs/parsers/hosts.md index 2aecaac7..dd77a886 100644 --- a/docs/parsers/hosts.md +++ b/docs/parsers/hosts.md @@ -81,7 +81,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/id.md b/docs/parsers/id.md index ac8efbc0..b37a97d7 100644 --- a/docs/parsers/id.md +++ b/docs/parsers/id.md @@ -112,7 +112,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ifconfig.md b/docs/parsers/ifconfig.md index 686426d7..de99c8db 100644 --- a/docs/parsers/ifconfig.md +++ b/docs/parsers/ifconfig.md @@ -193,7 +193,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ini.md b/docs/parsers/ini.md index eac8190d..5e2dc174 100644 --- a/docs/parsers/ini.md +++ b/docs/parsers/ini.md @@ -73,7 +73,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/iostat.md b/docs/parsers/iostat.md index fdf63c60..b8e5fae5 100644 --- a/docs/parsers/iostat.md +++ b/docs/parsers/iostat.md @@ -166,7 +166,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/iostat_s.md b/docs/parsers/iostat_s.md index 162fd3a9..8e598bbc 100644 --- a/docs/parsers/iostat_s.md +++ b/docs/parsers/iostat_s.md @@ -107,7 +107,7 @@ Examples: -#### parse +### parse ```python @add_jc_meta diff --git a/docs/parsers/iptables.md b/docs/parsers/iptables.md index 9a98a899..c51d6d13 100644 --- a/docs/parsers/iptables.md +++ b/docs/parsers/iptables.md @@ -170,7 +170,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/iw_scan.md b/docs/parsers/iw_scan.md index 5dd0bd85..b39de09e 100644 --- a/docs/parsers/iw_scan.md +++ b/docs/parsers/iw_scan.md @@ -128,7 +128,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/jar_manifest.md b/docs/parsers/jar_manifest.md index 2b14cebc..91964220 100644 --- a/docs/parsers/jar_manifest.md +++ b/docs/parsers/jar_manifest.md @@ -84,7 +84,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/jobs.md b/docs/parsers/jobs.md index 69209734..ab7da0dd 100644 --- a/docs/parsers/jobs.md +++ b/docs/parsers/jobs.md @@ -100,7 +100,7 @@ Example: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/kv.md b/docs/parsers/kv.md index 4b71f64d..9959671a 100644 --- a/docs/parsers/kv.md +++ b/docs/parsers/kv.md @@ -60,7 +60,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/last.md b/docs/parsers/last.md index b2dfb32c..910e405f 100644 --- a/docs/parsers/last.md +++ b/docs/parsers/last.md @@ -111,7 +111,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ls.md b/docs/parsers/ls.md index d3b0ea8b..578b3dfb 100644 --- a/docs/parsers/ls.md +++ b/docs/parsers/ls.md @@ -123,7 +123,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index 82ce4f6a..20bc6a90 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -84,7 +84,7 @@ Examples: -#### parse +### parse ```python @add_jc_meta diff --git a/docs/parsers/lsblk.md b/docs/parsers/lsblk.md index 24c8d6e8..0e8ba14e 100644 --- a/docs/parsers/lsblk.md +++ b/docs/parsers/lsblk.md @@ -281,7 +281,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/lsmod.md b/docs/parsers/lsmod.md index dda48fb4..705f45ff 100644 --- a/docs/parsers/lsmod.md +++ b/docs/parsers/lsmod.md @@ -132,7 +132,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/lsof.md b/docs/parsers/lsof.md index 90945628..bff7b40c 100644 --- a/docs/parsers/lsof.md +++ b/docs/parsers/lsof.md @@ -126,7 +126,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/lsusb.md b/docs/parsers/lsusb.md index 9be5c776..fa27c836 100644 --- a/docs/parsers/lsusb.md +++ b/docs/parsers/lsusb.md @@ -268,7 +268,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/mount.md b/docs/parsers/mount.md index cee2b027..e5bbea98 100644 --- a/docs/parsers/mount.md +++ b/docs/parsers/mount.md @@ -82,7 +82,7 @@ Example: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/netstat.md b/docs/parsers/netstat.md index 260237ef..01d0782b 100644 --- a/docs/parsers/netstat.md +++ b/docs/parsers/netstat.md @@ -362,7 +362,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/nmcli.md b/docs/parsers/nmcli.md index b0971100..3df6a3de 100644 --- a/docs/parsers/nmcli.md +++ b/docs/parsers/nmcli.md @@ -152,7 +152,7 @@ Examples: -#### parse +### parse ```python def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict] diff --git a/docs/parsers/ntpq.md b/docs/parsers/ntpq.md index 73e30589..ff043328 100644 --- a/docs/parsers/ntpq.md +++ b/docs/parsers/ntpq.md @@ -213,7 +213,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/passwd.md b/docs/parsers/passwd.md index f30b1f39..498c1cfb 100644 --- a/docs/parsers/passwd.md +++ b/docs/parsers/passwd.md @@ -101,7 +101,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ping.md b/docs/parsers/ping.md index eaea4e9c..a5e1f2cd 100644 --- a/docs/parsers/ping.md +++ b/docs/parsers/ping.md @@ -169,7 +169,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index 7fc3c204..f678bbca 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -90,7 +90,7 @@ Examples: -#### parse +### parse ```python @add_jc_meta diff --git a/docs/parsers/pip_list.md b/docs/parsers/pip_list.md index c05f99cb..33906cdf 100644 --- a/docs/parsers/pip_list.md +++ b/docs/parsers/pip_list.md @@ -54,7 +54,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/pip_show.md b/docs/parsers/pip_show.md index b378f604..661bc526 100644 --- a/docs/parsers/pip_show.md +++ b/docs/parsers/pip_show.md @@ -72,7 +72,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ps.md b/docs/parsers/ps.md index 51aece3a..ef02011a 100644 --- a/docs/parsers/ps.md +++ b/docs/parsers/ps.md @@ -213,7 +213,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/route.md b/docs/parsers/route.md index 961f21d8..022676a7 100644 --- a/docs/parsers/route.md +++ b/docs/parsers/route.md @@ -115,7 +115,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/rpm_qi.md b/docs/parsers/rpm_qi.md index 7e1c5782..b0238a17 100644 --- a/docs/parsers/rpm_qi.md +++ b/docs/parsers/rpm_qi.md @@ -168,7 +168,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/rsync.md b/docs/parsers/rsync.md index 1271c1e7..dd799fdf 100644 --- a/docs/parsers/rsync.md +++ b/docs/parsers/rsync.md @@ -141,7 +141,7 @@ Examples: -#### parse +### parse ```python def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict] diff --git a/docs/parsers/rsync_s.md b/docs/parsers/rsync_s.md index f42fc855..b3e41c30 100644 --- a/docs/parsers/rsync_s.md +++ b/docs/parsers/rsync_s.md @@ -95,7 +95,7 @@ Examples: -#### parse +### parse ```python @add_jc_meta diff --git a/docs/parsers/sfdisk.md b/docs/parsers/sfdisk.md index 91ee9862..4358b074 100644 --- a/docs/parsers/sfdisk.md +++ b/docs/parsers/sfdisk.md @@ -209,7 +209,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/shadow.md b/docs/parsers/shadow.md index fae577e2..ef615c26 100644 --- a/docs/parsers/shadow.md +++ b/docs/parsers/shadow.md @@ -108,7 +108,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ss.md b/docs/parsers/ss.md index bbe984f8..bd0ed975 100644 --- a/docs/parsers/ss.md +++ b/docs/parsers/ss.md @@ -287,7 +287,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/stat.md b/docs/parsers/stat.md index c950a568..9240b290 100644 --- a/docs/parsers/stat.md +++ b/docs/parsers/stat.md @@ -177,7 +177,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/stat_s.md b/docs/parsers/stat_s.md index 1b438ab2..0813541f 100644 --- a/docs/parsers/stat_s.md +++ b/docs/parsers/stat_s.md @@ -88,7 +88,7 @@ Examples: -#### parse +### parse ```python @add_jc_meta diff --git a/docs/parsers/sysctl.md b/docs/parsers/sysctl.md index c19ca743..e0ac3892 100644 --- a/docs/parsers/sysctl.md +++ b/docs/parsers/sysctl.md @@ -64,7 +64,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl.md b/docs/parsers/systemctl.md index 085ad486..e6d03231 100644 --- a/docs/parsers/systemctl.md +++ b/docs/parsers/systemctl.md @@ -65,7 +65,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl_lj.md b/docs/parsers/systemctl_lj.md index 007e8261..68bfed5d 100644 --- a/docs/parsers/systemctl_lj.md +++ b/docs/parsers/systemctl_lj.md @@ -82,7 +82,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl_ls.md b/docs/parsers/systemctl_ls.md index f5783a95..cd13a9c0 100644 --- a/docs/parsers/systemctl_ls.md +++ b/docs/parsers/systemctl_ls.md @@ -58,7 +58,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systemctl_luf.md b/docs/parsers/systemctl_luf.md index 79a858a2..ab3d2983 100644 --- a/docs/parsers/systemctl_luf.md +++ b/docs/parsers/systemctl_luf.md @@ -54,7 +54,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/systeminfo.md b/docs/parsers/systeminfo.md index 616e23dd..0b442e5f 100644 --- a/docs/parsers/systeminfo.md +++ b/docs/parsers/systeminfo.md @@ -218,7 +218,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/time.md b/docs/parsers/time.md index ed79b975..bdf3f1a4 100644 --- a/docs/parsers/time.md +++ b/docs/parsers/time.md @@ -139,7 +139,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/timedatectl.md b/docs/parsers/timedatectl.md index 94d50ed1..ddcd4c73 100644 --- a/docs/parsers/timedatectl.md +++ b/docs/parsers/timedatectl.md @@ -71,7 +71,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/tracepath.md b/docs/parsers/tracepath.md index 73d4f6ef..9a8256c5 100644 --- a/docs/parsers/tracepath.md +++ b/docs/parsers/tracepath.md @@ -138,7 +138,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/traceroute.md b/docs/parsers/traceroute.md index 2a0ff614..f98e5ba3 100644 --- a/docs/parsers/traceroute.md +++ b/docs/parsers/traceroute.md @@ -127,7 +127,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ufw.md b/docs/parsers/ufw.md index fa26ae84..86e625ee 100644 --- a/docs/parsers/ufw.md +++ b/docs/parsers/ufw.md @@ -207,7 +207,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/ufw_appinfo.md b/docs/parsers/ufw_appinfo.md index 54711331..cb15ac4d 100644 --- a/docs/parsers/ufw_appinfo.md +++ b/docs/parsers/ufw_appinfo.md @@ -145,7 +145,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/uname.md b/docs/parsers/uname.md index b4a9329e..d583146c 100644 --- a/docs/parsers/uname.md +++ b/docs/parsers/uname.md @@ -54,7 +54,7 @@ Example: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/universal.md b/docs/parsers/universal.md index fbd7edee..5327ed83 100644 --- a/docs/parsers/universal.md +++ b/docs/parsers/universal.md @@ -12,7 +12,7 @@ jc - JSON Convert universal parsers -#### simple\_table\_parse +### simple\_table\_parse ```python def simple_table_parse(data: List[str]) -> List[Dict] @@ -37,7 +37,7 @@ Returns: -#### sparse\_table\_parse +### sparse\_table\_parse ```python def sparse_table_parse(data: List[str], delim: str = '\u2063') -> List[Dict] diff --git a/docs/parsers/upower.md b/docs/parsers/upower.md index 55a9a4c6..f8d513a4 100644 --- a/docs/parsers/upower.md +++ b/docs/parsers/upower.md @@ -205,7 +205,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/uptime.md b/docs/parsers/uptime.md index f63a3d42..d2c5ccea 100644 --- a/docs/parsers/uptime.md +++ b/docs/parsers/uptime.md @@ -72,7 +72,7 @@ Example: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/vmstat.md b/docs/parsers/vmstat.md index 1690b11e..fea78a6a 100644 --- a/docs/parsers/vmstat.md +++ b/docs/parsers/vmstat.md @@ -133,7 +133,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index 8d39e959..c2d35e39 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -107,7 +107,7 @@ Examples: -#### parse +### parse ```python @add_jc_meta diff --git a/docs/parsers/w.md b/docs/parsers/w.md index e754b7c8..6ff07141 100644 --- a/docs/parsers/w.md +++ b/docs/parsers/w.md @@ -110,7 +110,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/wc.md b/docs/parsers/wc.md index f58d1058..2969bf12 100644 --- a/docs/parsers/wc.md +++ b/docs/parsers/wc.md @@ -61,7 +61,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/who.md b/docs/parsers/who.md index 7dfdd25e..7d7eed62 100644 --- a/docs/parsers/who.md +++ b/docs/parsers/who.md @@ -142,7 +142,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/xml.md b/docs/parsers/xml.md index fa866d76..6e822260 100644 --- a/docs/parsers/xml.md +++ b/docs/parsers/xml.md @@ -77,7 +77,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/xrandr.md b/docs/parsers/xrandr.md index d5c05e8f..76d926b7 100644 --- a/docs/parsers/xrandr.md +++ b/docs/parsers/xrandr.md @@ -144,7 +144,7 @@ Examples: -#### parse +### parse ```python def parse(data: str, raw: bool = False, quiet: bool = False) -> Dict diff --git a/docs/parsers/yaml.md b/docs/parsers/yaml.md index 18234a8c..6e774c7c 100644 --- a/docs/parsers/yaml.md +++ b/docs/parsers/yaml.md @@ -91,7 +91,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/parsers/zipinfo.md b/docs/parsers/zipinfo.md index e56ad2f0..e2ca96f7 100644 --- a/docs/parsers/zipinfo.md +++ b/docs/parsers/zipinfo.md @@ -86,7 +86,7 @@ Examples: -#### parse +### parse ```python def parse(data, raw=False, quiet=False) diff --git a/docs/streaming.md b/docs/streaming.md index f97f9d9f..71e61b8a 100644 --- a/docs/streaming.md +++ b/docs/streaming.md @@ -16,7 +16,7 @@ jc - JSON Convert streaming utils -#### streaming\_input\_type\_check +### streaming\_input\_type\_check ```python def streaming_input_type_check(data: Iterable) -> None @@ -27,7 +27,7 @@ Ensure input data is an iterable, but not a string or bytes. Raises -#### streaming\_line\_input\_type\_check +### streaming\_line\_input\_type\_check ```python def streaming_line_input_type_check(line: str) -> None @@ -37,7 +37,7 @@ Ensure each line is a string. Raises `TypeError` if not. -#### stream\_success +### stream\_success ```python def stream_success(output_line: Dict, ignore_exceptions: bool) -> Dict @@ -47,7 +47,7 @@ Add `_jc_meta` object to output line if `ignore_exceptions=True` -#### stream\_error +### stream\_error ```python def stream_error(e: BaseException, line: str) -> Dict @@ -57,7 +57,7 @@ Return an error `_jc_meta` field. -#### add\_jc\_meta +### add\_jc\_meta ```python def add_jc_meta(func) @@ -102,7 +102,7 @@ In all cases above: -#### raise\_or\_yield +### raise\_or\_yield ```python def raise_or_yield(ignore_exceptions: bool, e: BaseException, diff --git a/docs/utils.md b/docs/utils.md index de72f4f7..f35a53a4 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -20,7 +20,7 @@ jc - JSON Convert utils -#### warning\_message +### warning\_message ```python def warning_message(message_lines: List[str]) -> None @@ -40,7 +40,7 @@ Returns: -#### error\_message +### error\_message ```python def error_message(message_lines: List[str]) -> None @@ -60,7 +60,7 @@ Returns: -#### compatibility +### compatibility ```python def compatibility(mod_name: str, @@ -87,7 +87,7 @@ Returns: -#### has\_data +### has\_data ```python def has_data(data: str) -> bool @@ -107,7 +107,7 @@ Returns: -#### convert\_to\_int +### convert\_to\_int ```python def convert_to_int(value: Union[str, float]) -> Optional[int] @@ -126,7 +126,7 @@ Returns: -#### convert\_to\_float +### convert\_to\_float ```python def convert_to_float(value: Union[str, int]) -> Optional[float] @@ -145,7 +145,7 @@ Returns: -#### convert\_to\_bool +### convert\_to\_bool ```python def convert_to_bool(value: Union[str, int, float]) -> bool @@ -165,7 +165,7 @@ Returns: -#### input\_type\_check +### input\_type\_check ```python def input_type_check(data: str) -> None @@ -175,7 +175,7 @@ Ensure input data is a string. Raises `TypeError` if not. -## timestamp Objects +### timestamp Objects ```python class timestamp() @@ -183,7 +183,7 @@ class timestamp() -#### \_\_init\_\_ +### \_\_init\_\_ ```python def __init__(datetime_string: str,