Skip to content

Commit

Permalink
DOC: new nan_to_num keywords are from 1.17 onwards (numpy#14219)
Browse files Browse the repository at this point in the history
* DOC: new nan_to_num keywords are from 1.17 onwards
  • Loading branch information
daureg authored and mattip committed Aug 8, 2019
1 parent 5a59872 commit 5096930
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion numpy/lib/type_check.py
Original file line number Diff line number Diff line change
Expand Up @@ -395,19 +395,27 @@ def nan_to_num(x, copy=True, nan=0.0, posinf=None, neginf=None):
in-place (False). The in-place operation only occurs if
casting to an array does not require a copy.
Default is True.
.. versionadded:: 1.13
nan : int, float, optional
Value to be used to fill NaN values. If no value is passed
then NaN values will be replaced with 0.0.
.. versionadded:: 1.17
posinf : int, float, optional
Value to be used to fill positive infinity values. If no value is
passed then positive infinity values will be replaced with a very
large number.
.. versionadded:: 1.17
neginf : int, float, optional
Value to be used to fill negative infinity values. If no value is
passed then negative infinity values will be replaced with a very
small (or negative) number.
.. versionadded:: 1.17
.. versionadded:: 1.13
Returns
-------
Expand Down

0 comments on commit 5096930

Please sign in to comment.