Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit eb25775

Browse files
committed
DOC: Numpydoc format.
Returns is supposed to be a description list to be properly parsed by numpydoc, otherwise each line is parsed as an individual item.
1 parent ec0132f commit eb25775

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

lib/matplotlib/__init__.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -273,9 +273,11 @@ def _get_executable_info(name):
273273
274274
Returns
275275
-------
276-
If the executable is found, a namedtuple with fields ``executable`` (`str`)
277-
and ``version`` (`distutils.version.LooseVersion`, or ``None`` if the
278-
version cannot be determined).
276+
277+
tuple or None:
278+
If the executable is found, a namedtuple with fields ``executable``
279+
(`str`) and ``version`` (`distutils.version.LooseVersion`, or ``None``
280+
if the version cannot be determined).
279281
280282
Raises
281283
------

lib/matplotlib/mlab.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -934,10 +934,11 @@ def cohere(x, y, NFFT=256, Fs=2, detrend=detrend_none, window=window_hanning,
934934
935935
Returns
936936
-------
937-
The return value is the tuple (*Cxy*, *f*), where *f* are the
938-
frequencies of the coherence vector. For cohere, scaling the
939-
individual densities by the sampling frequency has no effect,
940-
since the factors cancel out.
937+
938+
tuple (*Cxy*, *f*)
939+
where *f* are the frequencies of the coherence vector. For cohere,
940+
scaling the individual densities by the sampling frequency has no
941+
effect, since the factors cancel out.
941942
942943
See Also
943944
--------

0 commit comments

Comments
 (0)