Skip to content

Commit 148ed63

Browse files
mattayesjorisvandenbossche
authored andcommitted
DOC: Fix "drop=True" reset_index() reference in Feather and Parquet IO index caveats (#18285) (#18292)
1 parent 63e8527 commit 148ed63

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

doc/source/io.rst

+9-5
Original file line numberDiff line numberDiff line change
@@ -4427,8 +4427,10 @@ Several caveats.
44274427

44284428
- This is a newer library, and the format, though stable, is not guaranteed to be backward compatible
44294429
to the earlier versions.
4430-
- The format will NOT write an ``Index``, or ``MultiIndex`` for the ``DataFrame`` and will raise an
4431-
error if a non-default one is provided. You can simply ``.reset_index()`` in order to store the index.
4430+
- The format will NOT write an ``Index``, or ``MultiIndex`` for the
4431+
``DataFrame`` and will raise an error if a non-default one is provided. You
4432+
can ``.reset_index()`` to store the index or ``.reset_index(drop=True)`` to
4433+
ignore it.
44324434
- Duplicate column names and non-string columns names are not supported
44334435
- Non supported types include ``Period`` and actual python object types. These will raise a helpful error message
44344436
on an attempt at serialization.
@@ -4491,8 +4493,10 @@ dtypes, including extension dtypes such as datetime with tz.
44914493

44924494
Several caveats.
44934495

4494-
- The format will NOT write an ``Index``, or ``MultiIndex`` for the ``DataFrame`` and will raise an
4495-
error if a non-default one is provided. You can simply ``.reset_index(drop=True)`` in order to store the index.
4496+
- The format will NOT write an ``Index``, or ``MultiIndex`` for the
4497+
``DataFrame`` and will raise an error if a non-default one is provided. You
4498+
can ``.reset_index()`` to store the index or ``.reset_index(drop=True)`` to
4499+
ignore it.
44964500
- Duplicate column names and non-string columns names are not supported
44974501
- Categorical dtypes can be serialized to parquet, but will de-serialize as ``object`` dtype.
44984502
- Non supported types include ``Period`` and actual python object types. These will raise a helpful error message
@@ -4538,7 +4542,7 @@ Read from a parquet file.
45384542
45394543
result.dtypes
45404544
4541-
Read only certain columns of a parquet file.
4545+
Read only certain columns of a parquet file.
45424546

45434547
.. ipython:: python
45444548

0 commit comments

Comments
 (0)