From 68eeec19a812b735627763bb7d7e2a58b72f7504 Mon Sep 17 00:00:00 2001
From: Kelly Brazil <kellyjonbrazil@gmail.com>
Date: Wed, 11 Dec 2019 16:39:30 -0800
Subject: [PATCH] doc update

---
 README.md          |  4 ++--
 docs/parsers/df.md | 31 ++++++++++++++++++-------------
 jc/parsers/df.py   | 20 ++++++++++----------
 3 files changed, 30 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index 298e47a5..75315170 100755
--- a/README.md
+++ b/README.md
@@ -161,7 +161,7 @@ $ df | jc --df -p
 [
   {
     "filesystem": "devtmpfs",
-    "1k-blocks": 1918816,
+    "1k_blocks": 1918816,
     "used": 0,
     "available": 1918816,
     "use_percent": 0,
@@ -169,7 +169,7 @@ $ df | jc --df -p
   },
   {
     "filesystem": "tmpfs",
-    "1k-blocks": 1930664,
+    "1k_blocks": 1930664,
     "used": 0,
     "available": 1930664,
     "use_percent": 0,
diff --git a/docs/parsers/df.md b/docs/parsers/df.md
index 877b2f76..850b3e81 100644
--- a/docs/parsers/df.md
+++ b/docs/parsers/df.md
@@ -10,7 +10,7 @@ Examples:
     [
       {
         "filesystem": "devtmpfs",
-        "1k-blocks": 1918820,
+        "1k_blocks": 1918820,
         "used": 0,
         "available": 1918820,
         "use_percent": 0,
@@ -18,7 +18,7 @@ Examples:
       },
       {
         "filesystem": "tmpfs",
-        "1k-blocks": 1930668,
+        "1k_blocks": 1930668,
         "used": 0,
         "available": 1930668,
         "use_percent": 0,
@@ -26,7 +26,7 @@ Examples:
       },
       {
         "filesystem": "tmpfs",
-        "1k-blocks": 1930668,
+        "1k_blocks": 1930668,
         "used": 11800,
         "available": 1918868,
         "use_percent": 1,
@@ -39,7 +39,7 @@ Examples:
     [
       {
         "filesystem": "devtmpfs",
-        "1k-blocks": "1918820",
+        "1k_blocks": "1918820",
         "used": "0",
         "available": "1918820",
         "use_percent": "0%",
@@ -47,7 +47,7 @@ Examples:
       },
       {
         "filesystem": "tmpfs",
-        "1k-blocks": "1930668",
+        "1k_blocks": "1930668",
         "used": "0",
         "available": "1930668",
         "use_percent": "0%",
@@ -55,7 +55,7 @@ Examples:
       },
       {
         "filesystem": "tmpfs",
-        "1k-blocks": "1930668",
+        "1k_blocks": "1930668",
         "used": "11800",
         "available": "1918868",
         "use_percent": "1%",
@@ -81,13 +81,18 @@ Returns:
 
     [
       {
-        "filesystem":   string,
-        "size":         string,
-        "1k-blocks":    integer,
-        "used":         integer,
-        "available":    integer,
-        "use_percent":  integer,
-        "mounted_on":   string
+        "filesystem":        string,
+        "size":              string,
+        "1k_blocks":         integer,
+        "512_blocks":        integer,
+        "used":              integer,
+        "available":         integer,
+        "capacity_percent":  integer,
+        "ifree":             integer,
+        "iused":             integer,
+        "use_percent":       integer,
+        "iused_percent":     integer,
+        "mounted_on":        string
       }
     ]
 
diff --git a/jc/parsers/df.py b/jc/parsers/df.py
index aeeb80dc..329f402c 100644
--- a/jc/parsers/df.py
+++ b/jc/parsers/df.py
@@ -9,7 +9,7 @@ Examples:
     [
       {
         "filesystem": "devtmpfs",
-        "1k-blocks": 1918820,
+        "1k_blocks": 1918820,
         "used": 0,
         "available": 1918820,
         "use_percent": 0,
@@ -17,7 +17,7 @@ Examples:
       },
       {
         "filesystem": "tmpfs",
-        "1k-blocks": 1930668,
+        "1k_blocks": 1930668,
         "used": 0,
         "available": 1930668,
         "use_percent": 0,
@@ -25,7 +25,7 @@ Examples:
       },
       {
         "filesystem": "tmpfs",
-        "1k-blocks": 1930668,
+        "1k_blocks": 1930668,
         "used": 11800,
         "available": 1918868,
         "use_percent": 1,
@@ -38,7 +38,7 @@ Examples:
     [
       {
         "filesystem": "devtmpfs",
-        "1k-blocks": "1918820",
+        "1k_blocks": "1918820",
         "used": "0",
         "available": "1918820",
         "use_percent": "0%",
@@ -46,7 +46,7 @@ Examples:
       },
       {
         "filesystem": "tmpfs",
-        "1k-blocks": "1930668",
+        "1k_blocks": "1930668",
         "used": "0",
         "available": "1930668",
         "use_percent": "0%",
@@ -54,7 +54,7 @@ Examples:
       },
       {
         "filesystem": "tmpfs",
-        "1k-blocks": "1930668",
+        "1k_blocks": "1930668",
         "used": "11800",
         "available": "1918868",
         "use_percent": "1%",
@@ -87,11 +87,11 @@ def process(proc_data):
             "512_blocks":        integer,
             "used":              integer,
             "available":         integer,
-            "capacity_percent":  integer, #
-            "ifree":             integer, #
-            "iused":             integer, #
+            "capacity_percent":  integer,
+            "ifree":             integer,
+            "iused":             integer,
             "use_percent":       integer,
-            "iused_percent":     integer, #
+            "iused_percent":     integer,
             "mounted_on":        string
           }
         ]