8000 Merge pull request #14214 from anntzer/pydocstyle · matplotlib/matplotlib@48bc2be · GitHub
[go: up one dir, main page]
Skip to content

Commit 48bc2be

Browse files
dstansbydstansby
authored
Merge pull request #14214 from anntzer/pydocstyle
Fix some docstring style issues.
2 parents 54be59e + e74a8bf commit 48bc2be

File tree

14 files changed

+33
-35
lines changed

14 files changed

+33
-35
lines changed

‎.flake8‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@ ignore =
1212
N801, N802, N803, N806, N812,
1313
# pydocstyle
1414
D100, D101, D102, D103, D104, D105, D106, D107,
15-
D200, D202, D203, D204, D205, D207, D208, D209,
16-
D210, D211, D212, D213, D214, D215,
17-
D300, D301, D302,
18-
D400, D401, D402, D403, D404, D405, D406, D407, D408, D409,
19-
D410, D411, D412, D413, D414,
15+
D200, D202, D203, D204, D205, D207, D208, D209, D212, D213,
16+
D300, D301
17+
D400, D401, D402, D403, D412, D413,
2018

2119
exclude =
2220
.git

‎doc/sphinxext/gallery_order.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828

2929
class MplExplicitOrder(ExplicitOrder):
30-
""" for use within the 'subsection_order' key"""
30+
"""For use within the 'subsection_order' key."""
3131
def __call__(self, item):
3232
"""Return a string determining the sort order."""
3333
if item in self.ordered_list:
@@ -65,7 +65,7 @@ def __call__(self, item):
6565

6666

6767
class MplExplicitSubOrder(object):
68-
""" for use within the 'within_subsection_order' key """
68+
"""For use within the 'within_subsection_order' key."""
6969
def __init__(self, src_dir):
7070
self.src_dir = src_dir # src_dir is unused here
7171
self.ordered_list = explicit_subsection_order

‎lib/matplotlib/__init__.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -705,12 +705,11 @@ def gen_candidates():
705705

706706

707707
class RcParams(MutableMapping, dict):
708-
709708
"""
710-
A dictionary object including validation
709+
A dictionary object including validation.
711710
712-
validating functions are defined and associated with rc parameters in
713-
:mod:`matplotlib.rcsetup`
711+
Validating functions are defined and associated with rc parameters in
712+
:mod:`matplotlib.rcsetup`.
714713
"""
715714

716715
validate = {key: converter

‎lib/matplotlib/_layoutbox.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,7 @@ def soft_constraints(self):
223223
sol.addConstraint(i | 150000)
224224

225225
def set_parent(self, parent):
226-
''' replace the parent of this with the new parent
227-
'''
226+
"""Replace the parent of this with the new parent."""
228227
self.parent = parent
229228
self.parent_constrain()
230229

@@ -378,14 +377,15 @@ def find_child_subplots(self):
378377

379378
def layout_from_subplotspec(self, subspec,
380379
name='', artist=None, pos=False):
381-
''' Make a layout box from a subplotspec. The layout box is
380+
"""
381+
Make a layout box from a subplotspec. The layout box is
382382
constrained to be a fraction of the width/height of the parent,
383383
and be a fraction of the parent width/height from the left/bottom
384384
of the parent. Therefore the parent can move around and the
385385
layout for the subplot spec should move with it.
386386
387387
The parent is *usually* the gridspec that made the subplotspec.??
388-
'''
388+
"""
389389
lb = LayoutBox(parent=self, name=name, artist=artist, pos=pos)
390390
gs = subspec.get_gridspec()
391391
nrows, ncols = gs.get_geometry()

‎lib/matplotlib/backends/backend_qt5.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -674,7 +674,7 @@ class NavigationToolbar2QT(NavigationToolbar2, QtWidgets.QToolBar):
674674
message = QtCore.Signal(str)
675675

676676
def __init__(self, canvas, parent, coordinates=True):
677-
""" coordinates: should we show the coordinates on the right? """
677+
"""coordinates: should we show the coordinates on the right?"""
678678
self.canvas = canvas
679679
self.parent = parent
680680
self.coordinates = coordinates

‎lib/matplotlib/backends/backend_wx.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -836,7 +836,7 @@ def _onKeyUp(self, evt):
836836
evt.Skip()
837837

838838
def _set_capture(self, capture=True):
839-
"""control wx mouse capture """
839+
"""Control wx mouse capture."""
840840
if self.HasCapture():
841841
self.ReleaseMouse()
842842
if capture:

‎lib/matplotlib/bezier.py‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,8 @@ def split_de_casteljau(beta, t):
9898
@cbook._rename_parameter("3.1", "tolerence", "tolerance")
9999
def find_bezier_t_intersecting_with_closedpath(
100100
bezier_point_at_t, inside_closedpath, t0=0., t1=1., tolerance=0.01):
101-
""" Find a parameter t0 and t1 of the given bezier path which
101+
"""
102+
Find a parameter t0 and t1 of the given bezier path which
102103
bounds the intersecting points with a provided closed
103104
path(*inside_closedpath*). Search starts from *t0* and *t1* and it
104105
uses a simple bisecting algorithm therefore one of the end point
@@ -223,8 +224,9 @@ def _f(r):
223224

224225
@cbook._rename_parameter("3.1", "tolerence", "tolerance")
225226
def split_path_inout(path, inside, tolerance=0.01, reorder_inout=False):
226-
""" divide a path into two segment at the point where inside(x, y)
227-
becomes False.
227+
"""
228+
Divide a path into two segments at the point where ``inside(x, y)`` becomes
229+
False.
228230
"""
229231

230232
path_iter = path.iter_segments()
@@ -306,10 +308,9 @@ def get_cos_sin(x0, y0, x1, y1):
306308

307309
@cbook._rename_parameter("3.1", "tolerence", "tolerance")
308310
def check_if_parallel(dx1, dy1, dx2, dy2, tolerance=1.e-5):
309-
""" returns
310-
* 1 if two lines are parallel in same direction
311-
* -1 if two lines are parallel in opposite direction
312-
* 0 otherwise
311+
"""
312+
Return 1 if two lines are parallel in same direction, -1 if two lines are
313+
parallel in opposite direction, 0 otherwise.
313314
"""
314315
theta1 = np.arctan2(dx1, dy1)
315316
theta2 = np.arctan2(dx2, dy2)

‎lib/matplotlib/dates.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ class strpdate2num(object):
321321
you know the date format string of the date you are parsing.
322322
"""
323323
def __init__(self, fmt):
324-
""" fmt: any valid strptime format is supported """
324+
"""fmt: any valid strptime format is supported"""
325325
self.fmt = fmt
326326

327327
def __call__(self, s):

‎lib/matplotlib/tests/test_axes.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3572,7 +3572,7 @@ def test_empty_eventplot():
35723572
([[]], [[], [0, 1]], [[0, 1], []]),
35733573
('_empty', 'vertical', 'horizontal', None, 'none')))
35743574
def test_eventplot_orientation(data, orientation):
3575-
"""Introduced when fixing issue #6412. """
3575+
"""Introduced when fixing issue #6412."""
35763576
opts = {} if orientation == "_empty" else {'orientation': orientation}
35773577
fig, ax = plt.subplots(1, 1)
35783578
ax.eventplot(data, **opts)
@@ -5581,7 +5581,7 @@ def test_broken_barh_empty():
55815581

55825582

55835583
def test_broken_barh_timedelta():
5584-
"""Check that timedelta works as x, dx pair for this method """
5584+
"""Check that timedelta works as x, dx pair for this method."""
55855585
fig, ax = plt.subplots()
55865586
pp = ax.broken_barh([(datetime.datetime(2018, 11, 9, 0, 0, 0),
55875587
datetime.timedelta(hours=1))], [1, 2])

‎lib/matplotlib/tests/test_constrainedlayout.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ def test_constrained_layout10():
184184
@image_comparison(baseline_images=['constrained_layout11'],
185185
extensions=['png'])
186186
def test_constrained_layout11():
187-
'Test for multiple nested gridspecs '
187+
'Test for multiple nested gridspecs'
188188
fig = plt.figure(constrained_layout=True, figsize=(10, 3))
189189
gs0 = gridspec.GridSpec(1, 2, figure=fig)
190190
gsl = gridspec.GridSpecFromSubplotSpec(1, 2, gs0[0])

0 commit comments

Comments
 (0)
0