Cleanup docs for GraphicsContextBase.{get,set}_dashes.

anntzer · anntzer · commit d5bddbc81a18 · 2019-02-26T13:35:32.000+01:00
Note that the docs for get_dashes was wrong: the dash list is in points,
not in pixels; this is documented e.g. in the line_demo_dash_control
example; also the default dashstyle is (None, None).
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -801,16 +801,14 @@ def get_clip_path(self):
 
     def get_dashes(self):
         """
-        Return the dash information as an offset dashlist tuple.
+        Return the dash style as an (offset, dash-list) pair.
 
-        The dash list is a even size list that gives the ink on, ink
-        off in pixels.
+        The dash list is a even-length list that gives the ink on, ink off in
+        points.  See p. 107 of to PostScript `blue book`_ for more info.
 
-        See p107 of to PostScript `BLUEBOOK
-        <https://www-cdf.fnal.gov/offline/PostScript/BLUEBOOK.PDF>`_
-        for more info.
+        Default value is (None, None).
 
-        Default value is None
+        .. _blue book: https://www-cdf.fnal.gov/offline/PostScript/BLUEBOOK.PDF
         """
         return self._dashes
 
@@ -904,13 +902,18 @@ def set_dashes(self, dash_offset, dash_list):
 
         Parameters
         ----------
-        dash_offset : float
-            is the offset (usually 0).
+        dash_offset : float or None
+            The offset (usually 0).
+        dash_list : array_like or None
+            The on-off sequence as points.
 
-        dash_list : array_like
-            specifies the on-off sequence as points.
-            ``(None, None)`` specifies a solid line
+        Notes
+        -----
+        ``(None, None)`` specifies a solid line.
+
+        See p. 107 of to PostScript `blue book`_ for more info.
 
+        .. _blue book: https://www-cdf.fnal.gov/offline/PostScript/BLUEBOOK.PDF
         """
         if dash_list is not None:
             dl = np.asarray(dash_list)
