Skip to content

Commit 61810c5

Browse files
luke396luke396
committed
DOC: More doc fix for dtype_backend
1 parent a5e812d commit 61810c5

File tree

6 files changed

+62
-62
lines changed

6 files changed

+62
-62
lines changed

‎pandas/core/dtypes/cast.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1011,14 +1011,14 @@ def convert_dtypes(
10111011
infer_objects : bool, defaults False
10121012
Whether to also infer objects to float/int if possible. Is only hit if the
10131013
object array contains pd.NA.
1014-
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'
1014+
dtype_backend : {'numpy_nullable', 'pyarrow'}
10151015
Back-end data type applied to the resultant :class:`DataFrame`
1016-
(still experimental). Behaviour is as follows:
1016+
(still experimental). If not specified, the default behavior
1017+
is to not use nullable data types. If specified, the behavior
1018+
is as follows:
10171019
1018-
* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
1019-
(default).
1020-
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
1021-
DataFrame.
1020+
* ``"numpy_nullable"``: returns with nullable-dtype-backed
1021+
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`
10221022
10231023
.. versionadded:: 2.0
10241024

‎pandas/core/generic.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6650,14 +6650,14 @@ def convert_dtypes(
66506650
Whether, if possible, conversion can be done to floating extension types.
66516651
If `convert_integer` is also True, preference will be give to integer
66526652
dtypes if the floats can be faithfully casted to integers.
6653-
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'
6654-
Back-end data type applied to the resultant :class:`DataFrame` or
6655-
:class:`Series` (still experimental). Behaviour is as follows:
6656-
6657-
* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
6658-
or :class:`Series` (default).
6659-
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
6660-
DataFrame or Series.
6653+
dtype_backend : {'numpy_nullable', 'pyarrow'}
6654+
Back-end data type applied to the resultant :class:`DataFrame`
6655+
(still experimental). If not specified, the default behavior
6656+
is to not use nullable data types. If specified, the behavior
6657+
is as follows:
6658+
6659+
* ``"numpy_nullable"``: returns with nullable-dtype-backed
6660+
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`
66616661
66626662
.. versionadded:: 2.0
66636663

‎pandas/io/clipboards.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ def read_clipboard(
3838
A string or regex delimiter. The default of ``'\\s+'`` denotes
3939
one or more whitespace characters.
4040
41-
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'
41+
dtype_backend : {'numpy_nullable', 'pyarrow'}
4242
Back-end data type applied to the resultant :class:`DataFrame`
43-
(still experimental). Behaviour is as follows:
43+
(still experimental). If not specified, the default behavior
44+
is to not use nullable data types. If specified, the behavior
45+
is as follows:
4446
45-
* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
46-
(default).
47-
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
48-
DataFrame.
47+
* ``"numpy_nullable"``: returns with nullable-dtype-backed
48+
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`
4949
5050
.. versionadded:: 2.0
5151

‎pandas/io/orc.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,14 @@ def read_orc(
6161
Output always follows the ordering of the file and not the columns list.
6262
This mirrors the original behaviour of
6363
:external+pyarrow:py:meth:`pyarrow.orc.ORCFile.read`.
64-
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'
64+
dtype_backend : {'numpy_nullable', 'pyarrow'}
6565
Back-end data type applied to the resultant :class:`DataFrame`
66-
(still experimental). Behaviour is as follows:
66+
(still experimental). If not specified, the default behavior
67+
is to not use nullable data types. If specified, the behavior
68+
is as follows:
6769
68-
* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
69-
(default).
70-
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
71-
DataFrame.
70+
* ``"numpy_nullable"``: returns with nullable-dtype-backed
71+
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`
7272
7373
.. versionadded:: 2.0
7474

‎pandas/io/spss.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ def read_spss(
3636
Return a subset of the columns. If None, return all columns.
3737
convert_categoricals : bool, default is True
3838
Convert categorical columns into pd.Categorical.
39-
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'
39+
dtype_backend : {'numpy_nullable', 'pyarrow'}
4040
Back-end data type applied to the resultant :class:`DataFrame`
41-
(still experimental). Behaviour is as follows:
41+
(still experimental). If not specified, the default behavior
42+
is to not use nullable data types. If specified, the behavior
43+
is as follows:
4244
43-
* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
44-
(default).
45-
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
46-
DataFrame.
45+
* ``"numpy_nullable"``: returns with nullable-dtype-backed
46+
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`
4747
4848
.. versionadded:: 2.0
4949

‎pandas/io/sql.py

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -306,14 +306,14 @@ def read_sql_table(
306306
chunksize : int, default None
307307
If specified, returns an iterator where `chunksize` is the number of
308308
rows to include in each chunk.
309-
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'
309+
dtype_backend : {'numpy_nullable', 'pyarrow'}
310310
Back-end data type applied to the resultant :class:`DataFrame`
311-
(still experimental). Behaviour is as follows:
311+
(still experimental). If not specified, the default behavior
312+
is to not use nullable data types. If specified, the behavior
313+
is as follows:
312314
313-
* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
314-
(default).
315-
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
316-
DataFrame.
315+
* ``"numpy_nullable"``: returns with nullable-dtype-backed
316+
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`
317317
318318
.. versionadded:: 2.0
319319
@@ -443,14 +443,14 @@ def read_sql_query(
443443
{'a': np.float64, 'b': np.int32, 'c': 'Int64'}.
444444
445445
.. versionadded:: 1.3.0
446-
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'
446+
dtype_backend : {'numpy_nullable', 'pyarrow'}
447447
Back-end data type applied to the resultant :class:`DataFrame`
448-
(still experimental). Behaviour is as follows:
448+
(still experimental). If not specified, the default behavior
449+
is to not use nullable data types. If specified, the behavior
450+
is as follows:
449451
450-
* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
451-
(default).
452-
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
453-
DataFrame.
452+
* ``"numpy_nullable"``: returns with nullable-dtype-backed
453+
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`
454454
455455
.. versionadded:: 2.0
456456
@@ -586,14 +586,14 @@ def read_sql(
586586
chunksize : int, default None
587587
If specified, return an iterator where `chunksize` is the
588588
number of rows to include in each chunk.
589-
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'
589+
dtype_backend : {'numpy_nullable', 'pyarrow'}
590590
Back-end data type applied to the resultant :class:`DataFrame`
591-
(still experimental). Behaviour is as follows:
591+
(still experimental). If not specified, the default behavior
592+
is to not use nullable data types. If specified, the behavior
593+
is as follows:
592594
593-
* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
594-
(default).
595-
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
596-
DataFrame.
595+
* ``"numpy_nullable"``: returns with nullable-dtype-backed
596+
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`
597597
598598
.. versionadded:: 2.0
599599
dtype : Type name or dict of columns
@@ -1683,14 +1683,14 @@ def read_table(
16831683
chunksize : int, default None
16841684
If specified, return an iterator where `chunksize` is the number
16851685
of rows to include in each chunk.
1686-
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'
1686+
dtype_backend : {'numpy_nullable', 'pyarrow'}
16871687
Back-end data type applied to the resultant :class:`DataFrame`
1688-
(still experimental). Behaviour is as follows:
1688+
(still experimental). If not specified, the default behavior
1689+
is to not use nullable data types. If specified, the behavior
1690+
is as follows:
16891691
1690-
* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
1691-
(default).
1692-
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
1693-
DataFrame.
1692+
* ``"numpy_nullable"``: returns with nullable-dtype-backed
1693+
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`
16941694
16951695
.. versionadded:: 2.0
16961696
@@ -2148,14 +2148,14 @@ def read_table(
21482148
schema of the SQL database object.
21492149
chunksize : int, default None
21502150
Raises NotImplementedError
2151-
dtype_backend : {'numpy_nullable', 'pyarrow'}, default 'numpy_nullable'
2151+
dtype_backend : {'numpy_nullable', 'pyarrow'}
21522152
Back-end data type applied to the resultant :class:`DataFrame`
2153-
(still experimental). Behaviour is as follows:
2153+
(still experimental). If not specified, the default behavior
2154+
is to not use nullable data types. If specified, the behavior
2155+
is as follows:
21542156
2155-
* ``"numpy_nullable"``: returns nullable-dtype-backed :class:`DataFrame`
2156-
(default).
2157-
* ``"pyarrow"``: returns pyarrow-backed nullable :class:`ArrowDtype`
2158-
DataFrame.
2157+
* ``"numpy_nullable"``: returns with nullable-dtype-backed
2158+
* ``"pyarrow"``: returns with pyarrow-backed nullable :class:`ArrowDtype`
21592159
21602160
.. versionadded:: 2.0
21612161

0 commit comments

Comments
 (0)