Skip to content

Commit 472898e

Browse files
rthjnothman
authored andcommitted
Minor style improvements to doc/example.py to pass validation (#243)
1 parent 7f98102 commit 472898e

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

doc/example.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@
3535

3636

3737
def foo(var1, var2, long_var_name='hi'):
38-
r"""A one-line summary that does not use variable names or the
39-
function name.
38+
r"""A one-line summary that does not use variable names.
4039
4140
Several sentences providing an extended description. Refer to
4241
variables using back-ticks, e.g. `var`.
@@ -78,7 +77,7 @@ def foo(var1, var2, long_var_name='hi'):
7877
7978
See Also
8079
--------
81-
numpy.array : relationship (optional)
80+
numpy.array : Relationship (optional).
8281
numpy.ndarray : Relationship (optional), which could be fairly long, in
8382
which case the line wraps here.
8483
numpy.dot, numpy.linalg.norm, numpy.eye
@@ -117,7 +116,6 @@ def foo(var1, var2, long_var_name='hi'):
117116
>>> print("a\nb")
118117
a
119118
b
120-
121119
"""
122120
# After closing class docstring, there should be one blank line to
123121
# separate following codes (according to PEP257).

0 commit comments

Comments
 (0)