Rename entityList to entitylist

Added some documentation
Geotab · Dec 7, 2020 · 4839597 · 4839597
1 parent f8bf55b
commit 4839597
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 5 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -12,8 +12,6 @@ Querying Data
    :inherited-members:
    :members:
 
-.. autoclass:: EntityList
-
 .. autoclass:: MyGeotabException
 
 .. autoclass:: TimeoutException
@@ -35,6 +33,16 @@ Date Helpers
 Extras
 ------
 
+EntityList
+~~~~~~~~~~
+
+.. autoclass:: mygeotab.ext.entitylist.API
+   :inherited-members:
+   :members:
+
+.. autoclass:: mygeotab.ext.entitylist.EntityList
+   :members:
+
 Data Feed
 ~~~~~~~~~
 

diff --git a/mygeotab/ext/__init__.py b/mygeotab/ext/__init__.py
@@ -1,4 +1,4 @@
-from .entityList import API
+from .entitylist import API
 from .feed import DataFeed, DataFeedListener
 
 __all__ = ["API", "DataFeed", "DatafeedListener"]
diff --git a/mygeotab/ext/entityList.py → mygeotab/ext/entitylist.py b/mygeotab/ext/entityList.py → mygeotab/ext/entitylist.py
@@ -1,9 +1,15 @@
+# -*- coding: utf-8 -*-
+
 import six
 from mygeotab import api
 from six.moves import UserList
 
 
 class API(api.API):
+    """An experimental wrapper around the base MyGeotab API class that adds some helper methods to results when
+    retrieving results with `get()`.
+    """
+
     def get(self, type_name, **parameters):
         return EntityList(super().get(type_name, **parameters), type_name=type_name)
 
@@ -133,5 +139,5 @@ def to_dataframe(self, normalize=False):
                 from pandas.io.json import json_normalize
 
                 return json_normalize(self.data)
-                
+
         return pandas.DataFrame.from_dict(self.data)
diff --git a/tests/test_api_entitylist.py b/tests/test_api_entitylist.py
@@ -3,7 +3,7 @@
 from datetime import datetime
 
 import pytest
-from mygeotab.ext.entityList import EntityList
+from mygeotab.ext.entitylist import EntityList
 
 
 class TestEntityList: