Add some minimal 🎎.

theengineear · theengineear · commit a06b11689019 · 2015-09-26T14:08:13.000+07:00
diff --git a/plotly/exceptions.py b/plotly/exceptions.py
@@ -82,13 +82,22 @@ class PlotlyEmptyDataError(PlotlyError):
 # Graph Objects Errors
 class PlotlyGraphObjectError(PlotlyError):
     def __init__(self, message='', path=(), notes=()):
+        """
+        General graph object error for validation failures.
+
+        :param (str|unicode) message: The error message.
+        :param (iterable) path: A path pointing to the error.
+        :param notes: Add additional notes, but keep default exception message.
+
+        """
         self.message = message
         self.plain_message = message  # for backwards compat
         self.path = list(path)
         self.notes = notes
         super(PlotlyGraphObjectError, self).__init__(message)
 
     def __str__(self):
+        """This is called by Python to present the error message."""
         format_dict = {
             'message': self.message,
             'path': '[' + ']['.join(repr(k) for k in self.path) + ']',
@@ -102,6 +111,7 @@ def __str__(self):
 
 class PlotlyDictKeyError(PlotlyGraphObjectError):
     def __init__(self, obj, path, notes=()):
+        """See PlotlyGraphObjectError.__init__ for param docs."""
         format_dict = {'attribute': path[-1], 'object_name': obj._name}
         message = ("'{attribute}' is not allowed in '{object_name}'"
                    .format(**format_dict))
@@ -113,6 +123,7 @@ def __init__(self, obj, path, notes=()):
 
 class PlotlyDictValueError(PlotlyGraphObjectError):
     def __init__(self, obj, path, notes=()):
+        """See PlotlyGraphObjectError.__init__ for param docs."""
         format_dict = {'attribute': path[-1], 'object_name': obj._name}
         message = ("'{attribute}' has invalid value inside '{object_name}'"
                    .format(**format_dict))
@@ -124,6 +135,7 @@ def __init__(self, obj, path, notes=()):
 
 class PlotlyListEntryError(PlotlyGraphObjectError):
     def __init__(self, obj, path, notes=()):
+        """See PlotlyGraphObjectError.__init__ for param docs."""
         format_dict = {'index': path[-1], 'object_name': obj._name}
         message = ("Invalid entry found in '{object_name}' at index, '{index}'"
                    .format(**format_dict))
@@ -135,6 +147,7 @@ def __init__(self, obj, path, notes=()):
 
 class PlotlyDataTypeError(PlotlyGraphObjectError):
     def __init__(self, obj, path, notes=()):
+        """See PlotlyGraphObjectError.__init__ for param docs."""
         format_dict = {'index': path[-1], 'object_name': obj._name}
         message = ("Invalid entry found in '{object_name}' at index, '{index}'"
                    .format(**format_dict))
