Added docs for exceptions (#23)

* Added docs for exceptions

* Added docs for models

Author: mattmanley

docs/index.rst

@@ -14,6 +14,10 @@ Welcome to MapRoulette's documentation!
 
    usage/getting_started
    usage/functionality
+   usage/models/project
+   usage/models/challenge
+   usage/models/task
+   usage/exceptions
 
 ---------------
 

docs/usage/exceptions.rst

@@ -0,0 +1,15 @@
+Exceptions
+=====================================================
+
+.. autoexception:: maproulette.api.errors.MapRouletteBaseException
+    :show-inheritance:
+.. autoexception:: maproulette.api.errors.NotFoundError
+    :show-inheritance:
+.. autoexception:: maproulette.api.errors.ConnectionUnavailableError
+    :show-inheritance:
+.. autoexception:: maproulette.api.errors.UnauthorizedError
+    :show-inheritance:
+.. autoexception:: maproulette.api.errors.HttpError
+    :show-inheritance:
+.. autoexception:: maproulette.api.errors.InvalidJsonError
+    :show-inheritance:

docs/usage/models/challenge.rst

@@ -0,0 +1,8 @@
+Challenge Model
+=====================================================
+
+.. automodule:: maproulette.models.challenge
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:

docs/usage/models/project.rst

@@ -0,0 +1,8 @@
+Project Model
+=====================================================
+
+.. automodule:: maproulette.models.project
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:

docs/usage/models/task.rst

@@ -0,0 +1,8 @@
+Task Model
+=====================================================
+
+.. automodule:: maproulette.models.task
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:

maproulette/api/errors.py

@@ -1,4 +1,3 @@
-import json
 """This module contains the set of MapRoulette's exceptions"""
 
 

maproulette/models/challenge.py

@@ -9,14 +9,17 @@ class ChallengeModel:
 
     @property
     def path(self):
+        """The path to the challenge"""
         return os.path.join("challenge", self._id)
 
     @property
     def id(self):
+        """The ID of the challenge"""
         return self._id
 
     @property
     def name(self):
+        """The internal name of the challenge"""
         return self._name
 
     @name.setter
@@ -25,6 +28,7 @@ def name(self, value):
 
     @property
     def description(self):
+        """The description for the challenge"""
         return self._description
 
     @description.setter
@@ -33,6 +37,7 @@ def description(self, value):
 
     @property
     def parent(self):
+        """The parent ID for the challenge"""
         return self._parent
 
     @parent.setter
@@ -41,6 +46,7 @@ def parent(self, value):
 
     @property
     def instruction(self):
+        """The instruction for the challenge"""
         return self._instruction
 
     @instruction.setter
@@ -49,6 +55,7 @@ def instruction(self, value):
 
     @property
     def difficulty(self):
+        """The difficulty setting for the challenge"""
         return self._difficulty
 
     @difficulty.setter
@@ -57,6 +64,7 @@ def difficulty(self, value):
 
     @property
     def blurb(self):
+        """The blurb for the challenge"""
         return self._blurb
 
     @blurb.setter
@@ -65,6 +73,7 @@ def blurb(self, value):
 
     @property
     def enabled(self):
+        """Whether this challenge is enabled for use or not"""
         return self._enabled
 
     @enabled.setter
@@ -73,6 +82,7 @@ def enabled(self, value):
 
     @property
     def challenge_type(self):
+        """The type for this challenge"""
         return self._challenge_type
 
     @challenge_type.setter
@@ -81,6 +91,7 @@ def challenge_type(self, value):
 
     @property
     def featured(self):
+        """Whether or not this challenge is featured"""
         return self._featured
 
     @featured.setter
@@ -89,6 +100,7 @@ def featured(self, value):
 
     @property
     def overpassQL(self):
+        """The Overpass query for this challenge"""
         return self._overpassQL
 
     @overpassQL.setter
@@ -97,6 +109,7 @@ def overpassQL(self, value):
 
     @property
     def default_priority(self):
+        """The default priority for this challenge"""
         return self._default_priority
 
     @default_priority.setter
@@ -105,6 +118,7 @@ def default_priority(self, value):
 
     @property
     def default_zoom(self):
+        """The default zoom level for this challenge"""
         return self._default_zoom
 
     @default_zoom.setter
@@ -113,6 +127,7 @@ def default_zoom(self, value):
 
     @property
     def min_zoom(self):
+        """The minimum zoom level for this challenge"""
         return self._min_zoom
 
     @min_zoom.setter
@@ -121,6 +136,7 @@ def min_zoom(self, value):
 
     @property
     def max_zoom(self):
+        """The maximum zoom level for this challenge"""
         return self._max_zoom
 
     @max_zoom.setter
@@ -147,6 +163,7 @@ def __init__(self, name, id=None, description=None, parent=None, instruction=Non
         self._max_zoom = max_zoom
 
     def to_dict(self):
+        """Converts all non-null properties of a challenge object into a dictionary"""
         properties = {
             "id": self._id,
             "name": self._name,
@@ -167,4 +184,5 @@ def to_dict(self):
         return {k: v for (k, v) in properties.items() if v is not None}
 
     def to_json(self):
+        """Converts all non-null properties of a challenge object into a JSON object"""
         return json.dumps(self.to_dict())

maproulette/models/project.py

@@ -11,14 +11,17 @@ class ProjectModel:
 
     @property
     def path(self):
+        """The path to the project"""
         return os.path.join("project", str(self._id))
 
     @property
     def id(self):
+        """The ID of the project"""
         return self._id
 
     @property
     def name(self):
+        """The internal name of the project"""
         return self._name
 
     @name.setter
@@ -27,6 +30,7 @@ def name(self, value):
 
     @property
     def description(self):
+        """The description for the project"""
         return self._description
 
     @description.setter
@@ -35,6 +39,7 @@ def description(self, value):
 
     @property
     def groups(self):
+        """The groups that are associated with the project"""
         return self._groups
 
     @groups.setter
@@ -43,6 +48,7 @@ def groups(self, value):
 
     @property
     def enabled(self):
+        """Whether this project is enabled for use or not"""
         return self._enabled
 
     @enabled.setter
@@ -51,6 +57,7 @@ def enabled(self, value):
 
     @property
     def display_name(self):
+        """The friendly name that can be displayed to users"""
         return self._display_name
 
     @display_name.setter
@@ -59,6 +66,7 @@ def display_name(self, value):
 
     @property
     def is_virtual(self):
+        """Whether or not this project is virtual"""
         return self._is_virtual
 
     @is_virtual.setter
@@ -75,6 +83,7 @@ def __init__(self, name, id=None, description=None, groups=None, enabled=None, d
         self._is_virtual = is_virtual
 
     def to_dict(self):
+        """Converts all non-null properties of a project object into a dictionary"""
         properties = {
             "id": self._id,
             "name": self._name,
@@ -87,4 +96,5 @@ def to_dict(self):
         return {k: v for (k, v) in properties.items() if v is not None}
 
     def to_json(self):
+        """Converts all non-null properties of a project object into a JSON object"""
         return json.dumps(self.to_dict())