Skip to content

Minor docstring format cleanup #11064

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
Apr 17, 2018
Merged

Minor docstring format cleanup #11064

Show file tree
Hide file tree
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
14 changes: 7 additions & 7 deletions lib/matplotlib/artist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,17 +548,17 @@ def get_sketch_params(self):
-------
sketch_params : tuple or `None`

A 3-tuple with the following elements:
A 3-tuple with the following elements:

* `scale`: The amplitude of the wiggle perpendicular to the
source line.
* `scale`: The amplitude of the wiggle perpendicular to the
source line.

* `length`: The length of the wiggle along the line.
* `length`: The length of the wiggle along the line.

* `randomness`: The scale factor by which the length is
shrunken or expanded.
* `randomness`: The scale factor by which the length is
shrunken or expanded.

May return `None` if no sketch parameters were set.
May return `None` if no sketch parameters were set.
"""
return self._sketch

Expand Down
14 changes: 7 additions & 7 deletions lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1173,17 +1173,17 @@ def get_sketch_params(self):
-------
sketch_params : tuple or `None`

A 3-tuple with the following elements:
A 3-tuple with the following elements:

* `scale`: The amplitude of the wiggle perpendicular to the
source line.
* `scale`: The amplitude of the wiggle perpendicular to the
source line.

* `length`: The length of the wiggle along the line.
* `length`: The length of the wiggle along the line.

* `randomness`: The scale factor by which the length is
shrunken or expanded.
* `randomness`: The scale factor by which the length is
shrunken or expanded.

May return `None` if no sketch parameters were set.
May return `None` if no sketch parameters were set.
"""
return self._sketch

Expand Down
10 changes: 5 additions & 5 deletions lib/matplotlib/backend_managers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def __init__(self, name, sender, message):

class ToolManager(object):
"""
Helper class that groups all the user interactions for a Figure
Helper class that groups all the user interactions for a Figure.

Attributes
----------
Expand Down Expand Up @@ -90,12 +90,12 @@ def figure(self, figure):

def set_figure(self, figure, update_tools=True):
"""
Sets the figure to interact with the tools
Bind the given figure to the tools.

Parameters
==========
figure: `Figure`
update_tools: bool
----------
figure : `.Figure`
update_tools : bool
Force tools to update figure
"""
if self._key_press_handler_id:
Expand Down