Skip to content

DOC : fix errors docstrings pandas.to_numeric #32354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 6, 2020
Merged

DOC : fix errors docstrings pandas.to_numeric #32354

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d4474c
fix errors docstrings pandas.to_numeric
isoletslicer Feb 29, 2020
6536d62
revert back int to integer
isoletslicer Mar 3, 2020
d8494f2
Update numeric.py
WillAyd Mar 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions pandas/core/tools/numeric.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,23 @@ def to_numeric(arg, errors="raise", downcast=None):
Parameters
----------
arg : scalar, list, tuple, 1-d array, or Series
Arg is consists of any kinds of type :
- scalar is any kind of numeric type data.
- list is any kind of '[]' dtypes.
- tuple is any kind of '()' dtypes.
- 1-d array is list dtypes that only have 1 list.
- Series is kind of pandas 1-d ndarray with axis labels.
errors : {'ignore', 'raise', 'coerce'}, default 'raise'
- If 'raise', then invalid parsing will raise an exception.
- If 'coerce', then invalid parsing will be set as NaN.
- If 'ignore', then invalid parsing will return the input.
downcast : {'integer', 'signed', 'unsigned', 'float'}, default None
downcast : {'int', 'signed', 'unsigned', 'float'}, default None
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change this back to integer, you are completely right when it comes to the type of rhe variable that we want the python type name and not the pre-historic name, but in this case it's the value, and code below will check if downcast is equals to integer and not for int

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alright, ill be back soon

If not None, and if the data has been successfully cast to a
numerical dtype (or if the data was numeric to begin with),
downcast that resulting data to the smallest numerical dtype
possible according to the following rules:

- 'integer' or 'signed': smallest signed int dtype (min.: np.int8)
- 'int' or 'signed': smallest signed int dtype (min.: np.int8)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change this back as well

- 'unsigned': smallest unsigned int dtype (min.: np.uint8)
- 'float': smallest float dtype (min.: np.float32)

Expand All @@ -61,7 +67,8 @@ def to_numeric(arg, errors="raise", downcast=None):

Returns
-------
ret : numeric if parsing succeeded.
ret
Numeric if parsing succeeded.
Return type depends on input. Series if Series, otherwise ndarray.

See Also
Expand Down