From 2f805da24d0e833e3d2a1f3a5ec34031fa911c05 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 13 Nov 2019 08:04:40 -0800 Subject: [PATCH] add colon to parameter in docs --- docs/parsers/arp.md | 2 +- docs/parsers/df.md | 2 +- docs/parsers/dig.md | 2 +- docs/parsers/env.md | 2 +- docs/parsers/free.md | 2 +- docs/parsers/history.md | 2 +- docs/parsers/ifconfig.md | 2 +- docs/parsers/iptables.md | 2 +- docs/parsers/jobs.md | 2 +- docs/parsers/ls.md | 2 +- docs/parsers/lsblk.md | 2 +- docs/parsers/lsmod.md | 2 +- docs/parsers/lsof.md | 2 +- docs/parsers/mount.md | 2 +- docs/parsers/netstat.md | 2 +- docs/parsers/ps.md | 2 +- docs/parsers/route.md | 2 +- docs/parsers/ss.md | 2 +- docs/parsers/uname.md | 2 +- docs/parsers/uptime.md | 2 +- docs/parsers/w.md | 2 +- docs/utils.md | 8 ++++---- jc/parsers/arp.py | 2 +- jc/parsers/df.py | 2 +- jc/parsers/dig.py | 2 +- jc/parsers/env.py | 2 +- jc/parsers/foo.py | 2 +- jc/parsers/free.py | 2 +- jc/parsers/history.py | 2 +- jc/parsers/ifconfig.py | 2 +- jc/parsers/iptables.py | 2 +- jc/parsers/jobs.py | 2 +- jc/parsers/ls.py | 2 +- jc/parsers/lsblk.py | 2 +- jc/parsers/lsmod.py | 2 +- jc/parsers/lsof.py | 2 +- jc/parsers/mount.py | 2 +- jc/parsers/netstat.py | 2 +- jc/parsers/ps.py | 2 +- jc/parsers/route.py | 2 +- jc/parsers/ss.py | 2 +- jc/parsers/uname.py | 2 +- jc/parsers/uptime.py | 2 +- jc/parsers/w.py | 2 +- jc/utils.py | 8 ++++---- 45 files changed, 51 insertions(+), 51 deletions(-) diff --git a/docs/parsers/arp.md b/docs/parsers/arp.md index 9074777d..2b37709d 100644 --- a/docs/parsers/arp.md +++ b/docs/parsers/arp.md @@ -87,7 +87,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/df.md b/docs/parsers/df.md index b65974a9..877b2f76 100644 --- a/docs/parsers/df.md +++ b/docs/parsers/df.md @@ -73,7 +73,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/dig.md b/docs/parsers/dig.md index 2c5898ea..cb2e7e07 100644 --- a/docs/parsers/dig.md +++ b/docs/parsers/dig.md @@ -325,7 +325,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/env.md b/docs/parsers/env.md index 42ee6170..2c0f781c 100644 --- a/docs/parsers/env.md +++ b/docs/parsers/env.md @@ -53,7 +53,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/free.md b/docs/parsers/free.md index cffa9a33..6d3a3f6a 100644 --- a/docs/parsers/free.md +++ b/docs/parsers/free.md @@ -53,7 +53,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/history.md b/docs/parsers/history.md index ffdca2d4..9cea8820 100644 --- a/docs/parsers/history.md +++ b/docs/parsers/history.md @@ -45,7 +45,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/ifconfig.md b/docs/parsers/ifconfig.md index 6c201875..f6f1a8b7 100644 --- a/docs/parsers/ifconfig.md +++ b/docs/parsers/ifconfig.md @@ -129,7 +129,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/iptables.md b/docs/parsers/iptables.md index c8faa693..f6d68c5d 100644 --- a/docs/parsers/iptables.md +++ b/docs/parsers/iptables.md @@ -135,7 +135,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/jobs.md b/docs/parsers/jobs.md index ae6de833..b798ed67 100644 --- a/docs/parsers/jobs.md +++ b/docs/parsers/jobs.md @@ -77,7 +77,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/ls.md b/docs/parsers/ls.md index 0c353420..17796e2c 100644 --- a/docs/parsers/ls.md +++ b/docs/parsers/ls.md @@ -144,7 +144,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/lsblk.md b/docs/parsers/lsblk.md index 39794dd1..b413e922 100644 --- a/docs/parsers/lsblk.md +++ b/docs/parsers/lsblk.md @@ -216,7 +216,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/lsmod.md b/docs/parsers/lsmod.md index c5e22a1d..95063265 100644 --- a/docs/parsers/lsmod.md +++ b/docs/parsers/lsmod.md @@ -107,7 +107,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/lsof.md b/docs/parsers/lsof.md index b60cf254..2798327d 100644 --- a/docs/parsers/lsof.md +++ b/docs/parsers/lsof.md @@ -97,7 +97,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/mount.md b/docs/parsers/mount.md index 15b00314..9c0c8033 100644 --- a/docs/parsers/mount.md +++ b/docs/parsers/mount.md @@ -57,7 +57,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/netstat.md b/docs/parsers/netstat.md index 353174e0..a5c7a0c0 100644 --- a/docs/parsers/netstat.md +++ b/docs/parsers/netstat.md @@ -313,7 +313,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/ps.md b/docs/parsers/ps.md index 4a39e574..e6042c1d 100644 --- a/docs/parsers/ps.md +++ b/docs/parsers/ps.md @@ -177,7 +177,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/route.md b/docs/parsers/route.md index 3cd94391..8de6d98b 100644 --- a/docs/parsers/route.md +++ b/docs/parsers/route.md @@ -101,7 +101,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/ss.md b/docs/parsers/ss.md index 8e6a6d1a..e2eaf9c3 100644 --- a/docs/parsers/ss.md +++ b/docs/parsers/ss.md @@ -143,7 +143,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/uname.md b/docs/parsers/uname.md index 62c92ea6..ab725922 100644 --- a/docs/parsers/uname.md +++ b/docs/parsers/uname.md @@ -30,7 +30,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/uptime.md b/docs/parsers/uptime.md index 301e9590..deabc3a3 100644 --- a/docs/parsers/uptime.md +++ b/docs/parsers/uptime.md @@ -35,7 +35,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/parsers/w.md b/docs/parsers/w.md index 8dd0776e..b937ad0f 100644 --- a/docs/parsers/w.md +++ b/docs/parsers/w.md @@ -83,7 +83,7 @@ Final processing to conform to the schema. Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/docs/utils.md b/docs/utils.md index 4167feb9..0baa3879 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -9,7 +9,7 @@ Prints a warning message for non-fatal issues Parameters: - message (string) text of message + message: (string) text of message Returns: @@ -24,7 +24,7 @@ Prints an error message for fatal issues Parameters: - message (string) text of message + message: (string) text of message Returns: @@ -38,9 +38,9 @@ Checks for the parser's compatibility with the running OS platform. Parameters: - mod_name (string) __name__ of the calling module + mod_name: (string) __name__ of the calling module - compatible (list) sys.platform name(s) compatible with the parser + compatible: (list) sys.platform name(s) compatible with the parser compatible options: linux, darwin, cygwin, win32, aix, freebsd diff --git a/jc/parsers/arp.py b/jc/parsers/arp.py index 50f58500..506d2b5a 100644 --- a/jc/parsers/arp.py +++ b/jc/parsers/arp.py @@ -86,7 +86,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/df.py b/jc/parsers/df.py index f0ac6c6a..69dcf885 100644 --- a/jc/parsers/df.py +++ b/jc/parsers/df.py @@ -72,7 +72,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/dig.py b/jc/parsers/dig.py index a764d319..9de29af3 100644 --- a/jc/parsers/dig.py +++ b/jc/parsers/dig.py @@ -324,7 +324,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/env.py b/jc/parsers/env.py index 775c01e4..aad3f9b7 100644 --- a/jc/parsers/env.py +++ b/jc/parsers/env.py @@ -52,7 +52,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/foo.py b/jc/parsers/foo.py index 42bb7fad..2252f009 100644 --- a/jc/parsers/foo.py +++ b/jc/parsers/foo.py @@ -20,7 +20,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/free.py b/jc/parsers/free.py index bce35b53..f96b61ea 100644 --- a/jc/parsers/free.py +++ b/jc/parsers/free.py @@ -52,7 +52,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/history.py b/jc/parsers/history.py index 8c489d6a..bd6f56d8 100644 --- a/jc/parsers/history.py +++ b/jc/parsers/history.py @@ -44,7 +44,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/ifconfig.py b/jc/parsers/ifconfig.py index df06c03a..c03da7a4 100644 --- a/jc/parsers/ifconfig.py +++ b/jc/parsers/ifconfig.py @@ -129,7 +129,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/iptables.py b/jc/parsers/iptables.py index 6e50c3b1..db53e755 100644 --- a/jc/parsers/iptables.py +++ b/jc/parsers/iptables.py @@ -134,7 +134,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/jobs.py b/jc/parsers/jobs.py index 4c5f0ce4..22d7c672 100644 --- a/jc/parsers/jobs.py +++ b/jc/parsers/jobs.py @@ -77,7 +77,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/ls.py b/jc/parsers/ls.py index 97f6c51d..110454ac 100644 --- a/jc/parsers/ls.py +++ b/jc/parsers/ls.py @@ -144,7 +144,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/lsblk.py b/jc/parsers/lsblk.py index a0a8b6be..d60ed30f 100644 --- a/jc/parsers/lsblk.py +++ b/jc/parsers/lsblk.py @@ -216,7 +216,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/lsmod.py b/jc/parsers/lsmod.py index 4cbd90c7..409f6c14 100644 --- a/jc/parsers/lsmod.py +++ b/jc/parsers/lsmod.py @@ -106,7 +106,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/lsof.py b/jc/parsers/lsof.py index 50e489a5..78f0011e 100644 --- a/jc/parsers/lsof.py +++ b/jc/parsers/lsof.py @@ -97,7 +97,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/mount.py b/jc/parsers/mount.py index c9f7681a..9a20e8f3 100644 --- a/jc/parsers/mount.py +++ b/jc/parsers/mount.py @@ -56,7 +56,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/netstat.py b/jc/parsers/netstat.py index 310ae19c..91337e54 100644 --- a/jc/parsers/netstat.py +++ b/jc/parsers/netstat.py @@ -313,7 +313,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/ps.py b/jc/parsers/ps.py index 7f81d3f0..a5e21626 100644 --- a/jc/parsers/ps.py +++ b/jc/parsers/ps.py @@ -176,7 +176,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/route.py b/jc/parsers/route.py index 6859a839..b2d74d7e 100644 --- a/jc/parsers/route.py +++ b/jc/parsers/route.py @@ -100,7 +100,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/ss.py b/jc/parsers/ss.py index e941c0cf..5952046f 100644 --- a/jc/parsers/ss.py +++ b/jc/parsers/ss.py @@ -143,7 +143,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/uname.py b/jc/parsers/uname.py index 4602a84a..e4fb354f 100644 --- a/jc/parsers/uname.py +++ b/jc/parsers/uname.py @@ -29,7 +29,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/uptime.py b/jc/parsers/uptime.py index 3dbd09eb..b19dfdf4 100644 --- a/jc/parsers/uptime.py +++ b/jc/parsers/uptime.py @@ -34,7 +34,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/parsers/w.py b/jc/parsers/w.py index 4cadf51a..9ebc14cd 100644 --- a/jc/parsers/w.py +++ b/jc/parsers/w.py @@ -83,7 +83,7 @@ def process(proc_data): Parameters: - proc_data (dictionary) raw structured data to process + proc_data: (dictionary) raw structured data to process Returns: diff --git a/jc/utils.py b/jc/utils.py index 8d83a1b0..a33d2b1d 100644 --- a/jc/utils.py +++ b/jc/utils.py @@ -9,7 +9,7 @@ def warning_message(message): Parameters: - message (string) text of message + message: (string) text of message Returns: @@ -28,7 +28,7 @@ def error_message(message): Parameters: - message (string) text of message + message: (string) text of message Returns: @@ -46,9 +46,9 @@ def compatibility(mod_name, compatible): Parameters: - mod_name (string) __name__ of the calling module + mod_name: (string) __name__ of the calling module - compatible (list) sys.platform name(s) compatible with the parser + compatible: (list) sys.platform name(s) compatible with the parser compatible options: linux, darwin, cygwin, win32, aix, freebsd