enhance docs

jc/parsers/airport_s.py

@@ -1,4 +1,4 @@
-"""jc - JSON CLI output utility `airport -s` command parser
+"""jc - JSON CLI output utility `airport -s` command output parser
 
 The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`.
 

jc/parsers/arp.py

@@ -1,12 +1,14 @@
-"""jc - JSON CLI output utility arp Parser
+"""jc - JSON CLI output utility `arp` command output parser
+
+Supports `arp` and `arp -a` output.
 
 Usage (cli):
 
-    specify --arp as the first argument if the piped input is coming from:
+    $ arp | jc --arp
 
-    arp
-      or
-    arp -a
+    or
+
+    $ jc arp
 
 Usage (module):
 

jc/parsers/blkid.py

@@ -1,8 +1,12 @@
-"""jc - JSON CLI output utility blkid Parser
+"""jc - JSON CLI output utility `blkid` command output parser
 
 Usage (cli):
 
-    specify --blkid as the first argument if the piped input is coming from blkid
+    $ blkid | jc --blkid
+
+    or
+
+    $ jc blkid
 
 Usage (module):
 

jc/parsers/crontab.py

@@ -1,8 +1,14 @@
-"""jc - JSON CLI output utility crontab command and file Parser
+"""jc - JSON CLI output utility `crontab -l` command output and crontab file parser
+
+Supports `crontab -l` command output and crontab files.
 
 Usage (cli):
 
-    specify --crontab as the first argument if the piped input is coming from crontab -l or a crontab file
+    $ crontab -l | jc --crontab
+
+    or
+
+    $ jc crontab -l
 
 Usage (module):
 

jc/parsers/crontab_u.py

@@ -1,8 +1,10 @@
-"""jc - JSON CLI output utility crontab file Parser
+"""jc - JSON CLI output utility `crontab -l` command output and crontab file parser
+
+This version of the `crontab -l` parser supports output that contains user information for processes.
 
 Usage (cli):
 
-    specify --crontab-u as the first argument if the piped input is coming from a crontab file with User specified
+    $ crontab -l | jc --crontab-u
 
 Usage (module):
 

jc/parsers/csv.py

@@ -1,11 +1,10 @@
-"""jc - JSON CLI output utility csv Parser
+"""jc - JSON CLI output utility `csv` file parser
+
+The `csv` parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default to comma. The first row of the file must be a header row.
 
 Usage (cli):
 
-    specify --csv as the first argument if the piped input is coming from a csv file.
-    the csv parser will attempt to automatically detect the delimiter character.
-    if the delimiter cannot be detected it will default to comma.
-    the first row of the file must be a header row.
+    $ cat file.csv | jc --csv
 
 Usage (module):
 

jc/parsers/date.py

@@ -1,8 +1,12 @@
-"""jc - JSON CLI output utility date Parser
+"""jc - JSON CLI output utility `date` command output parser
 
 Usage (cli):
 
-    specify --date as the first argument if the piped input is coming from date
+    $ date | jc --date
+
+    or
+
+    $ jc date
 
 Usage (module):
 

jc/parsers/df.py

@@ -1,8 +1,12 @@
-"""jc - JSON CLI output utility df Parser
+"""jc - JSON CLI output utility `df` command output parser
 
 Usage (cli):
 
-    specify --df as the first argument if the piped input is coming from df
+    $ df | jc --df
+
+    or
+
+    $ jc df
 
 Usage (module):
 

jc/parsers/dig.py

@@ -1,8 +1,12 @@
-"""jc - JSON CLI output utility dig Parser
+"""jc - JSON CLI output utility `dig` command output parser
 
 Usage (cli):
 
-    Specify --dig as the first argument if the piped input is coming from dig
+    $ dig example.com | jc --dig
+
+    or
+
+    $ jc dig example.com
 
 Usage (module):
 

jc/parsers/dmidecode.py

@@ -1,8 +1,12 @@
-"""jc - JSON CLI output utility dmidecode Parser
+"""jc - JSON CLI output utility `dmidecode` command output parser
 
 Usage (cli):
 
-    specify --dmidecode as the first argument if the piped input is coming from dmidecode
+    $ dmidecode | jc --dmidecode
+
+    or
+
+    $ jc dmidecode
 
 Usage (module):
 

jc/parsers/du.py

@@ -1,8 +1,12 @@
-"""jc - JSON CLI output utility du Parser
+"""jc - JSON CLI output utility `du` command output parser
 
 Usage (cli):
 
-    specify --du as the first argument if the piped input is coming from du
+    $ du | jc --du
+
+    or
+
+    $ jc du
 
 Usage (module):
 

jc/parsers/env.py

@@ -1,8 +1,12 @@
-"""jc - JSON CLI output utility env Parser
+"""jc - JSON CLI output utility `env` command output parser
 
 Usage (cli):
 
-    specify --env as the first argument if the piped input is coming from env
+    $ env | jc --env
+
+    or
+
+    $ jc env
 
 Usage (module):
 

jc/parsers/file.py

@@ -1,8 +1,12 @@
-"""jc - JSON CLI output utility file command Parser
+"""jc - JSON CLI output utility `file` command output parser
 
 Usage (cli):
 
-    specify --file as the first argument if the piped input is coming from file.
+    $ file * | jc --file
+
+    or
+
+    $ jc file *
 
 Usage (module):
 

jc/parsers/foo.py

@@ -1,8 +1,14 @@
-"""jc - JSON CLI output utility foo Parser
+"""jc - JSON CLI output utility `foo` command output parser
+
+<<Short foo description and caveats>>
 
 Usage (cli):
 
-    specify --foo as the first argument if the piped input is coming from foo
+    $ foo | jc --foo
+
+    or
+
+    $ jc foo
 
 Usage (module):
 

jc/parsers/free.py

@@ -1,8 +1,12 @@
-"""jc - JSON CLI output utility free Parser
+"""jc - JSON CLI output utility `free` command output parser
 
 Usage (cli):
 
-    specify --free as the first argument if the piped input is coming from free
+    $ free | jc --free
+
+    or
+
+    $ jc free
 
 Usage (module):
 

jc/parsers/fstab.py

@@ -1,8 +1,8 @@
-"""jc - JSON CLI output utility fstab Parser
+"""jc - JSON CLI output utility `fstab` file parser
 
 Usage (cli):
 
-    specify --fstab as the first argument if the piped input is coming from a fstab file
+    $ cat /etc/fstab | jc --fstab
 
 Usage (module):