@@ -166,7 +166,7 @@ The sections of a function's docstring are:
166
166
x : type
167
167
Description of parameter `x`.
168
168
y
169
- Description of parameter `y` (with type not specified)
169
+ Description of parameter `y` (with type not specified).
170
170
171
171
Enclose variables in single backticks. The colon must be preceded
172
172
by a space, or omitted if the type is absent.
@@ -303,7 +303,7 @@ The sections of a function's docstring are:
303
303
304
304
See Also
305
305
--------
306
- average : Weighted average
306
+ average : Weighted average.
307
307
308
308
When referring to functions in the same sub-module, no prefix is
309
309
needed, and the tree is searched upwards for a match.
@@ -314,7 +314,7 @@ The sections of a function's docstring are:
314
314
315
315
::
316
316
317
- fft.fft2 : 2-D fast discrete Fourier transform
317
+ fft.fft2 : 2-D fast discrete Fourier transform.
318
318
319
319
When referring to an entirely different module::
320
320
@@ -426,7 +426,7 @@ The sections of a function's docstring are:
426
426
>>> np.add(1, 2)
427
427
3
428
428
429
- Comment explaining the second example
429
+ Comment explaining the second example.
430
430
431
431
>>> np.add([1, 2], [3, 4])
432
432
array([4, 6])
@@ -512,9 +512,9 @@ simply listed by name::
512
512
real
513
513
imag
514
514
x : float
515
- The X coordinate
515
+ The X coordinate.
516
516
y : float
517
- The Y coordinate
517
+ The Y coordinate.
518
518
519
519
In general, it is not necessary to list class methods. Those that are
520
520
not part of the public API have names that start with an underscore.
0 commit comments