Added exception docs

flask_journey/__init__.py

@@ -25,6 +25,8 @@ class Journey(object):
     Registers bundles and exposes properties for listing routes.
 
     :param app: App to pass directly to Journey
+    :raises:
+        - InvalidBundlesType if passed bundles is not of type list
     """
 
     def __init__(self, app=None, bundles=None):
@@ -44,6 +46,9 @@ def init_app(self, app):
         """Initializes Journey extension
 
         :param app: App passed from constructor or directly to init_app
+        :raises:
+            - NoBundlesAttached if no bundles has been attached attached
+
         """
 
         if len(self._attached_bundles) == 0:
@@ -99,7 +104,13 @@ def routes_simple(self):
 
         return routes
 
-    def bundle_exists(self, path):
+    def _bundle_exists(self, path):
+        """Checks if a bundle exists at the provided path
+
+        :param path: Bundle path
+        :return: bool
+        """
+
         for attached_bundle in self._attached_bundles:
             if path == attached_bundle.path:
                 return True
@@ -112,14 +123,16 @@ def attach_bundle(self, bundle):
         :param bundle: :class:`flask_journey.BlueprintBundle` object
         :raises:
             - IncompatibleBundle if the bundle is not of type `BlueprintBundle`
+            - DuplicateBundlePath if a bundle has already been attached at the same path
+            - MissingBlueprints if the bundle doesn't contain any blueprints
         """
 
         if not isinstance(bundle, BlueprintBundle):
             raise IncompatibleBundle('BlueprintBundle object passed to attach_bundle must be of type {0}'
                                      .format(BlueprintBundle))
         elif len(bundle.blueprints) == 0:
             raise MissingBlueprints("Bundles must contain at least one flask.Blueprint")
-        elif self.bundle_exists(bundle.path):
+        elif self._bundle_exists(bundle.path):
             raise DuplicateBundlePath("Duplicate bundle path {0}".format(bundle.path))
 
         self._attached_bundles.append(bundle)

flask_journey/blueprint_bundle.py

@@ -20,7 +20,9 @@ def sanitize_path(path):
         """Performs sanitation of the route path after validating
 
         :param path: path to sanitize
-        :return: sanitized path
+        :return: path string
+        :raises:
+            - InvalidBundlePath if the path doesn't start with a slash
         """
 
         if path[:1] != '/':
@@ -35,6 +37,8 @@ def attach_bp(self, bp, description=''):
 
         :param bp: :class:`flask.Blueprint` object
         :param description: Optional description string
+        :raises:
+            - InvalidBlueprint if the Blueprint is not of type `flask.Blueprint`
         """
 
         if not isinstance(bp, Blueprint):

flask_journey/utils.py

@@ -41,6 +41,8 @@ def route(bp, *args, **kwargs):
         - :body_schema: Deserialize JSON body with this schema
         - :query_schema: Deserialize Query string with this schema
         - :marshal_with: Serialize the output with this schema
+    :raises:
+        - ValidationError if the query parameters or JSON body fails validation
     """
 
     kwargs['strict_slashes'] = kwargs.pop('strict_slashes', False)