-
-
Notifications
You must be signed in to change notification settings - Fork 11.9k
Closed
Labels
Description
Issue with current documentation:
The ndarray.std and ndarray.var docstrings do not include the mean kwarg:
>>> import numpy as np
>>> np.__version__
'2.3.1'
>>> print(np.ndarray.std.__doc__)
a.std(axis=None, dtype=None, out=None, ddof=0, keepdims=False, *, where=True)
Returns the standard deviation of the array elements along given axis.
Refer to `numpy.std` for full documentation.
See Also
--------
numpy.std : equivalent function
But as it turns out, it's actually a thing:
>>> np.array([1, 2]).std()
np.float64(0.5)
>>> np.array([1, 2]).std(mean=1)
np.float64(0.7071067811865476)And even though I like this esoteric/peekaboo vibe, I suppose that correct docstrings can also be nice to have.
Idea or request for content:
No response