Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 2, 2019
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
Expand Down