Skip to content

Commit 05e5c2b

Browse files
Fix missing periods (#298)
1 parent 121c327 commit 05e5c2b

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

doc/example.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ def foo(var1, var2, *args, long_var_name='hi', **kwargs):
7171
Other Parameters
7272
----------------
7373
only_seldom_used_keywords : type
74-
Explanation
74+
Explanation.
7575
common_parameters_listed_above : type
76-
Explanation
76+
Explanation.
7777
7878
Raises
7979
------

doc/format.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ The sections of a function's docstring are:
166166
x : type
167167
Description of parameter `x`.
168168
y
169-
Description of parameter `y` (with type not specified)
169+
Description of parameter `y` (with type not specified).
170170

171171
Enclose variables in single backticks. The colon must be preceded
172172
by a space, or omitted if the type is absent.
@@ -303,7 +303,7 @@ The sections of a function's docstring are:
303303

304304
See Also
305305
--------
306-
average : Weighted average
306+
average : Weighted average.
307307

308308
When referring to functions in the same sub-module, no prefix is
309309
needed, and the tree is searched upwards for a match.
@@ -314,7 +314,7 @@ The sections of a function's docstring are:
314314

315315
::
316316

317-
fft.fft2 : 2-D fast discrete Fourier transform
317+
fft.fft2 : 2-D fast discrete Fourier transform.
318318

319319
When referring to an entirely different module::
320320

@@ -426,7 +426,7 @@ The sections of a function's docstring are:
426426
>>> np.add(1, 2)
427427
3
428428

429-
Comment explaining the second example
429+
Comment explaining the second example.
430430

431431
>>> np.add([1, 2], [3, 4])
432432
array([4, 6])
@@ -512,9 +512,9 @@ simply listed by name::
512512
real
513513
imag
514514
x : float
515-
The X coordinate
515+
The X coordinate.
516516
y : float
517-
The Y coordinate
517+
The Y coordinate.
518518

519519
In general, it is not necessary to list class methods. Those that are
520520
not part of the public API have names that start with an underscore.

0 commit comments

Comments
 (0)