From b83a9eba554530293f02e2b0d01dfbb14a3b2749 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Tue, 17 Apr 2018 03:48:26 +0200 Subject: [PATCH] Minor docstring format cleanup --- lib/matplotlib/artist.py | 14 +++++++------- lib/matplotlib/backend_bases.py | 14 +++++++------- lib/matplotlib/backend_managers.py | 10 +++++----- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py index c5e54f97a2f2..2d48bbb6ca9e 100644 --- a/lib/matplotlib/artist.py +++ b/lib/matplotlib/artist.py @@ -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 diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py index 6081aeb75e68..2e7499a7758a 100644 --- a/lib/matplotlib/backend_bases.py +++ b/lib/matplotlib/backend_bases.py @@ -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 diff --git a/lib/matplotlib/backend_managers.py b/lib/matplotlib/backend_managers.py index 57c3e7710cbe..53e1ee38dd7b 100644 --- a/lib/matplotlib/backend_managers.py +++ b/lib/matplotlib/backend_managers.py @@ -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 ---------- @@ -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: