Skip to content

Commit b011e80

Browse files
tacaswelltacaswell
committed
MNT: normalize inherit docstring comment + line length wrapping
1 parent 42253c9 commit b011e80

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

‎lib/matplotlib/legend_handler.py

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,9 @@ def create_artists(self, legend, orig_handle,
161161
The fontsize in pixels. The legend artists being created should
162162
be scaled according to the given fontsize.
163163
trans : `~matplotlib.transforms.Transform`
164-
The transform that is applied to the legend artists being created. Typically
165-
from unit coordinates in the handler box to screen coordinates.
164+
The transform that is applied to the legend artists being created.
165+
Typically from unit coordinates in the handler box to screen
166+
coordinates.
166167
"""
167168
raise NotImplementedError('Derived must override')
168169

@@ -307,7 +308,7 @@ class HandlerLine2D(HandlerNpoints):
307308
def create_artists(self, legend, orig_handle,
308309
xdescent, ydescent, width, height, fontsize,
309310
trans):
310-
# Doc-string inherited
311+
# docstring inherited
311312
xdata, xdata_marker = self.get_xdata(legend, xdescent, ydescent,
312313
width, height, fontsize)
313314

@@ -372,7 +373,7 @@ def _create_patch(self, legend, orig_handle,
372373

373374
def create_artists(self, legend, orig_handle,
374375
xdescent, ydescent, width, height, fontsize, trans):
375-
# Doc-string inherited
376+
# docstring inherited
376377
p = self._create_patch(legend, orig_handle,
377378
xdescent, ydescent, width, height, fontsize)
378379
self.update_prop(p, orig_handle, legend)
@@ -406,7 +407,7 @@ def _create_line(orig_handle, width, height):
406407

407408
def create_artists(self, legend, orig_handle,
408409
xdescent, ydescent, width, height, fontsize, trans):
409-
# Doc-string inherited
410+
# docstring inherited
410411
if orig_handle.get_fill() or (orig_handle.get_hatch() is not None):
411412
p = self._create_patch(orig_handle, xdescent, ydescent, width,
412413
height)
@@ -437,7 +438,7 @@ def _default_update_prop(self, legend_handle, orig_handle):
437438

438439
def create_artists(self, legend, orig_handle,
439440
xdescent, ydescent, width, height, fontsize, trans):
440-
# Doc-string inherited
441+
# docstring inherited
441442
xdata, xdata_marker = self.get_xdata(legend, xdescent, ydescent,
442443
width, height, fontsize)
443444
ydata = np.full_like(xdata, (height - ydescent) / 2)
@@ -504,7 +505,7 @@ def create_collection(self, orig_handle, sizes, offsets, offset_transform):
504505
def create_artists(self, legend, orig_handle,
505506
xdescent, ydescent, width, height, fontsize,
506507
trans):
507-
# Doc-string inherited
508+
# docstring inherited
508509
xdata, xdata_marker = self.get_xdata(legend, xdescent, ydescent,
509510
width, height, fontsize)
510511

@@ -568,7 +569,7 @@ def get_err_size(self, legend, xdescent, ydescent,
568569
def create_artists(self, legend, orig_handle,
569570
xdescent, ydescent, width, height, fontsize,
570571
trans):
571-
# Doc-string inherited
572+
# docstring inherited
572573
plotlines, caplines, barlinecols = orig_handle
573574

574575
xdata, xdata_marker = self.get_xdata(legend, xdescent, ydescent,
@@ -687,7 +688,7 @@ def get_ydata(self, legend, xdescent, ydescent, width, height, fontsize):
687688
def create_artists(self, legend, orig_handle,
688689
xdescent, ydescent, width, height, fontsize,
689690
trans):
690-
# Doc-string inherited
691+
# docstring inherited
691692
markerline, stemlines, baseline = orig_handle
692693
# Check to see if the stemcontainer is storing lines as a list or a
693694
# LineCollection. Eventually using a list will be removed, and this
@@ -765,7 +766,7 @@ def __init__(self, ndivide=1, pad=None, **kwargs):
765766
def create_artists(self, legend, orig_handle,
766767
xdescent, ydescent, width, height, fontsize,
767768
trans):
768-
# Doc-string inherited
769+
# docstring inherited
769770
handler_map = legend.get_legend_handler_map()
770771

771772
if self._ndivide is None:
@@ -832,7 +833,7 @@ def get_first(prop_array):
832833

833834
def create_artists(self, legend, orig_handle,
834835
xdescent, ydescent, width, height, fontsize, trans):
835-
# Doc-string inherited
836+
# docstring inherited
836837
p = Rectangle(xy=(-xdescent, -ydescent),
837838
width=width, height=height)
838839
self.update_prop(p, orig_handle, legend)

‎lib/matplotlib/patches.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3331,7 +3331,7 @@ def _get_bracket(self, x0, y0,
33313331
return vertices_arrow, codes_arrow
33323332

33333333
def transmute(self, path, mutation_size, linewidth):
3334-
# Doc-string inherited
3334+
# docstring inherited
33353335
if self._beginarrow_head or self._endarrow_head:
33363336
head_length = self.head_length * mutation_size
33373337
head_width = self.head_width * mutation_size
@@ -3598,7 +3598,7 @@ def __init__(self, head_length=.5, head_width=.5, tail_width=.2):
35983598
super().__init__()
35993599

36003600
def transmute(self, path, mutation_size, linewidth):
3601-
# Doc-string inherited
3601+
# docstring inherited
36023602
x0, y0, x1, y1, x2, y2 = self.ensure_quadratic_bezier(path)
36033603

36043604
# divide the path into a head and a tail
@@ -3677,7 +3677,7 @@ def __init__(self, head_length=.4, head_width=.4, tail_width=.4):
36773677
super().__init__()
36783678

36793679
def transmute(self, path, mutation_size, linewidth):
3680-
# Doc-string inherited
3680+
# docstring inherited
36813681
x0, y0, x1, y1, x2, y2 = self.ensure_quadratic_bezier(path)
36823682

36833683
# divide the path into a head and a tail
@@ -3766,7 +3766,7 @@ def __init__(self, tail_width=.3, shrink_factor=0.5):
37663766
super().__init__()
37673767

37683768
def transmute(self, path, mutation_size, linewidth):
3769-
# Doc-string inherited
3769+
# docstring inherited
37703770
x0, y0, x1, y1, x2, y2 = self.ensure_quadratic_bezier(path)
37713771

37723772
arrow_path = [(x0, y0), (x1, y1), (x2, y2)]

0 commit comments

Comments
 (0)