Sebastian Rahlf avatar Sebastian Rahlf committed 60c2f8d

Forgot to add some documentation to error base class.

Comments (0)

Files changed (1)

amazonproduct/errors.py

 ]
 
 class AWSError (Exception):
+
     """
-    Generic AWS error message.
+    Generic AWS error message with the following attributes:
+
+        ``code``
+            The Amazon error code (e.g. ``AWS.InvalidEnumeratedParameter``)
+
+        ``msg``
+            The original error message from Amazon
+
+        ``xml``
+            XML returned from Amazon as processed by the API's result processor
+
+    You can (and should) still pass additional arguments to derived exceptions
+    which (as with :class:`BaseException`) will be stored in ``args``.
     """
+
     def __init__(self, *args, **kwargs):
         Exception.__init__(self)
         self.args = args
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.