better warning message formatting

etpinard · etpinard · commit 8d9846391207 · 2014-07-04T18:11:03.000-04:00
diff --git a/plotly/matplotlylib/renderer.py b/plotly/matplotlylib/renderer.py
@@ -13,7 +13,7 @@
 
 # Warning format
 def warning_on_one_line(message, category, filename, lineno, file=None, line=None):
-    return ' %s:%s: %s:\n%s\n' % (filename, lineno, category.__name__, message)
+    return '%s:%s: %s:\n\n%s\n\n' % (filename, lineno, category.__name__, message)
 warnings.formatwarning = warning_on_one_line
 
 class PlotlyRenderer(Renderer):
@@ -503,14 +503,13 @@ def draw_text(self, **props):
         """
         self.msg += "    Attempting to draw an mpl text object\n"
         if not mpltools.check_corners(props['mplobj'], self.mpl_fig):
-            warnings.warn("Looks like the annotation(s) you are trying " 
-                          "to draw lies/lay outside the given figure size.\n"
-                          "Therefore, the resulting Plotly figure may not be "
-                          "large enough to view the full text.\n"
-                          "To adjust the size of the figure, use the "
-                          "'width' and 'height' keys in the Layout object. "
-                          "Alternatively, use the Margin object to adjust the "
-                          "figure's margins.")
+            warnings.warn("Looks like the annotation(s) you are trying \n" 
+                          "to draw lies/lay outside the given figure size.\n\n"
+                          "Therefore, the resulting Plotly figure may not be \n"
+                          "large enough to view the full text. To adjust \n"
+                          "the size of the figure, use the 'width' and \n"
+                          "'height' keys in the Layout object. Alternatively,\n"
+                          "use the Margin object to adjust the figure's margins.")
         align = props['mplobj']._multialignment
         if not align:
             align = props['style']['halign'] # mpl default
diff --git a/plotly/tools.py b/plotly/tools.py
@@ -16,7 +16,7 @@
 
 # Warning format
 def warning_on_one_line(message, category, filename, lineno, file=None, line=None):
-    return ' %s:%s: %s:\n%s\n' % (filename, lineno, category.__name__, message)
+    return '%s:%s: %s:\n\n%s\n\n' % (filename, lineno, category.__name__, message)
 warnings.formatwarning = warning_on_one_line
 
 try:
@@ -531,12 +531,12 @@ def _replace_newline(obj):
     elif isinstance(obj, (str, unicode)):
         s = obj.replace('\n', '<br>')
         if s != obj:
-            warnings.warn("Looks like you used a newline character: '\\n'.\n"
-                          "Plotly uses a subset of HTML escape characters "
-                          "to do things like newline, bold, italics, etc.\n"
-                          "Your newline characters have been converted to "
-                          "'<br>' so they will show up right on your Plotly "
-                          "figure!")
+            warnings.warn("Looks like you used a newline character: '\\n'.\n\n"
+                          "Plotly uses a subset of HTML escape characters\n"
+                          "to do things like newline (<br>), bold (<b></b>),\n"
+                          "italics (<i></i>), etc. Your newline characters \n"
+                          "have been converted to '<br>' so they will show \n"
+                          "up right on your Plotly figure!")
         return s
     else:
         return obj  # we return the actual reference... but DON'T mutate.
