updating docs

CHANGES.md

@@ -1,6 +1,6 @@
 # Changes from v0.1.2
 
-
+- added more depth to testing routine
 
 # Changes from v0.1.1
 

docs/height.html

@@ -148,6 +148,9 @@
 <li><p><strong>from_epsg</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em> or </em><em>None</em>) – Use an EPSG code to get a VRS to convert from</p></li>
 </ul>
 </dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.11)"><strong>AttributeError</strong></a> – if more than one of [from_model, from_vrs, from_wkt, from_epsg] is set</p>
+</dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="pyegt.height.HeightModel.as_dict">

docs/test.html

@@ -126,6 +126,7 @@
 <span class="p">}</span>
 </pre></div>
 </div>
+<p>If any test fails, the script will exit with an error after printing the results.</p>
 </dd></dl>
 
 <hr class="docutils" />

docs/utils.html

@@ -155,7 +155,10 @@
 <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.11)">dict</a></p>
 </dd>
 <dt class="field-even">Raises<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.11)"><strong>AttributeError</strong></a> – if the returned JSON has an error code</p>
+<dd class="field-even"><ul class="simple">
+<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.11)"><strong>AttributeError</strong></a> – if the returned JSON has an error indicating the set region is invalid</p></li>
+<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.11)"><strong>AttributeError</strong></a> – if the returned JSON has a generic error code</p></li>
+</ul>
 </dd>
 </dl>
 </dd></dl>

docsrc/_build/html/height.html

@@ -148,6 +148,9 @@
 <li><p><strong>from_epsg</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em> or </em><em>None</em>) – Use an EPSG code to get a VRS to convert from</p></li>
 </ul>
 </dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.11)"><strong>AttributeError</strong></a> – if more than one of [from_model, from_vrs, from_wkt, from_epsg] is set</p>
+</dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="pyegt.height.HeightModel.as_dict">

docsrc/_build/html/test.html

@@ -126,6 +126,7 @@
 <span class="p">}</span>
 </pre></div>
 </div>
+<p>If any test fails, the script will exit with an error after printing the results.</p>
 </dd></dl>
 
 <hr class="docutils" />

docsrc/_build/html/utils.html

@@ -155,7 +155,10 @@
 <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.11)">dict</a></p>
 </dd>
 <dt class="field-even">Raises<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.11)"><strong>AttributeError</strong></a> – if the returned JSON has an error code</p>
+<dd class="field-even"><ul class="simple">
+<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.11)"><strong>AttributeError</strong></a> – if the returned JSON has an error indicating the set region is invalid</p></li>
+<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.11)"><strong>AttributeError</strong></a> – if the returned JSON has a generic error code</p></li>
+</ul>
 </dd>
 </dl>
 </dd></dl>

pyegt/height.py

@@ -51,6 +51,7 @@ class HeightModel:
     :type from_wkt: str or None
     :param from_epsg: Use an EPSG code to get a VRS to convert from
     :type from_epsg: str or None
+    :raises AttributeError: if more than one of [from_model, from_vrs, from_wkt, from_epsg] is set
     """
     def __init__(self,
                  lat: float,

pyegt/test.py

@@ -35,6 +35,8 @@ def test():
                 'prvi': -45.473,
             }
         }
+
+    If any test fails, the script will exit with an error after printing the results.
     """
     TEST_COORDS = {
         defs.REGIONS[0]: {'lat': 44.256616, 'lon': -73.964784,}, # Jumping Complex, Lake Placid, NY

pyegt/utils.py

@@ -99,7 +99,8 @@ def get_vdatum_json(vdatum_url, region) -> dict:
     :param str region: The region to search
     :return: JSON response from VDatum API
     :rtype: dict
-    :raises AttributeError: if the returned JSON has an error code
+    :raises AttributeError: if the returned JSON has an error indicating the set region is invalid
+    :raises AttributeError: if the returned JSON has a generic error code
     """
     while True:
         print('Querying %s' % (vdatum_url))