Skip to content

DOC: Change to_numeric's dtype_backend default doc #59021

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.

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 6 commits into from
Jun 21, 2024
Merged
Changes from all commits
Commits
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
14 changes: 8 additions & 6 deletions pandas/core/tools/numeric.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ def to_numeric(
----------
arg : scalar, list, tuple, 1-d array, or Series
Argument to be converted.

errors : {'raise', 'coerce'}, default 'raise'
- If 'raise', then invalid parsing will raise an exception.
- If 'coerce', then invalid parsing will be set as NaN.
Expand All @@ -88,14 +89,15 @@ def to_numeric(
the dtype it is to be cast to, so if none of the dtypes
checked satisfy that specification, no downcasting will be
performed on the data.
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'

dtype_backend : {'numpy_nullable', 'pyarrow'}
Back-end data type applied to the resultant :class:`DataFrame`
(still experimental). Behaviour is as follows:
(still experimental). If not specified, the default behavior
is to not use nullable data types. If specified, the behavior
is as follows:

* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
(default).
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
DataFrame.
* ``"numpy_nullable"``: returns with nullable-dtype-backed
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`

.. versionadded:: 2.0

Expand Down
Loading