Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 325a1c8

Browse filesBrowse files
authored
Merge pull request #13524 from anntzer/dashes
Cleanup docs for GraphicsContextBase.{get,set}_dashes.
2 parents 66efef9 + d5bddbc commit 325a1c8
Copy full SHA for 325a1c8

File tree

Expand file treeCollapse file tree

1 file changed

+15
-12
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+15
-12
lines changed

‎lib/matplotlib/backend_bases.py

Copy file name to clipboardExpand all lines: lib/matplotlib/backend_bases.py
+15-12Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -801,16 +801,14 @@ def get_clip_path(self):
801801

802802
def get_dashes(self):
803803
"""
804-
Return the dash information as an offset dashlist tuple.
804+
Return the dash style as an (offset, dash-list) pair.
805805
806-
The dash list is a even size list that gives the ink on, ink
807-
off in pixels.
806+
The dash list is a even-length list that gives the ink on, ink off in
807+
points. See p. 107 of to PostScript `blue book`_ for more info.
808808
809-
See p107 of to PostScript `BLUEBOOK
810-
<https://www-cdf.fnal.gov/offline/PostScript/BLUEBOOK.PDF>`_
811-
for more info.
809+
Default value is (None, None).
812810
813-
Default value is None
811+
.. _blue book: https://www-cdf.fnal.gov/offline/PostScript/BLUEBOOK.PDF
814812
"""
815813
return self._dashes
816814

@@ -902,13 +900,18 @@ def set_dashes(self, dash_offset, dash_list):
902900
903901
Parameters
904902
----------
905-
dash_offset : float
906-
is the offset (usually 0).
903+
dash_offset : float or None
904+
The offset (usually 0).
905+
dash_list : array_like or None
906+
The on-off sequence as points.
907907
908-
dash_list : array_like
909-
specifies the on-off sequence as points.
910-
``(None, None)`` specifies a solid line
908+
Notes
909+
-----
910+
``(None, None)`` specifies a solid line.
911+
912+
See p. 107 of to PostScript `blue book`_ for more info.
911913
914+
.. _blue book: https://www-cdf.fnal.gov/offline/PostScript/BLUEBOOK.PDF
912915
"""
913916
if dash_list is not None:
914917
dl = np.asarray(dash_list)

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.