move json keys to notes

Zabamund · Aug 18, 2019 · 2f51c4b · 2f51c4b
1 parent 4cae60c
commit 2f51c4b
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/wellpathpy/header.py b/wellpathpy/header.py
@@ -22,6 +22,10 @@ def read_header_json(fname):
         "surface_northing": 2000.0
         }
 
+    Notes
+    -----
+    json file keys are:
+
     datum: str
         usually one of kb, dfe, rt
     elevation_units: str
@@ -35,17 +39,16 @@ def read_header_json(fname):
     surface_northing: float, optional
         wellhead surface location in <units> north of reference
 
-    Notes
-    -----
-    Datum is not used in calculation
+
+    datum is not used in calculation
+
     Abbreviations used:
         kb (kelly bushing)
         dfe (drill floor elevation)
         rt (rotary table)
         m (metres)
         ft (feet)
 
-
     Returns
     -------
     dict