Merge pull request #11336 from timhoffm/raw-strings-for-docstrings-with-escape

jklymak · tacaswell · commit fa5b1e1e8e4d · 2018-08-04T19:33:02.000-04:00
Use raw string literals for docstrings with escapes

Conflicts:
	lib/matplotlib/artist.py
          - reject py2 incompatible changes
	lib/matplotlib/axes/_axes.py
         - also backports some documentation changes
diff --git a/examples/shapes_and_collections/donut.py b/examples/shapes_and_collections/donut.py
@@ -1,4 +1,4 @@
-"""
+r"""
 =============
 Mmh Donuts!!!
 =============
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -1069,12 +1069,11 @@ class ArtistInspector(object):
     current values.
     """
     def __init__(self, o):
-        """
-        Initialize the artist inspector with an
-        :class:`~matplotlib.artist.Artist` or iterable of :class:`Artists`.
-        If an iterable is used, we assume it is a homogeneous sequence (all
-        :class:`Artists` are of the same type) and it is your responsibility
-        to make sure this is so.
+        r"""
+        Initialize the artist inspector with an `Artist` or an iterable of
+        `Artist`\s.  If an iterable is used, we assume it is a homogeneous
+        sequence (all `Artists` are of the same type) and it is your
+        responsibility to make sure this is so.
         """
         if not isinstance(o, Artist):
             if cbook.iterable(o):

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""`
	`1`	`+r"""`
`2`	`2`	`=============`
`3`	`3`	`Mmh Donuts!!!`
`4`	`4`	`=============`