Skip to content

Commit faeda18

Browse files
mattayesTomAugspurger
authored andcommitted
DOC: Fix "drop=True" reset_index() reference in Feather and Parquet IO index caveats (#18285) (#18292)
(cherry picked from commit 148ed63)
1 parent c0e4acd commit faeda18

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
@@ -4469,8 +4469,10 @@ Several caveats.
44694469

44704470
- This is a newer library, and the format, though stable, is not guaranteed to be backward compatible
44714471
to the earlier versions.
4472-
- The format will NOT write an ``Index``, or ``MultiIndex`` for the ``DataFrame`` and will raise an
4473-
error if a non-default one is provided. You can simply ``.reset_index()`` in order to store the index.
4472+
- The format will NOT write an ``Index``, or ``MultiIndex`` for the
4473+
``DataFrame`` and will raise an error if a non-default one is provided. You
4474+
can ``.reset_index()`` to store the index or ``.reset_index(drop=True)`` to
4475+
ignore it.
44744476
- Duplicate column names and non-string columns names are not supported
44754477
- Non supported types include ``Period`` and actual python object types. These will raise a helpful error message
44764478
on an attempt at serialization.
@@ -4533,8 +4535,10 @@ dtypes, including extension dtypes such as datetime with tz.
45334535

45344536
Several caveats.
45354537

4536-
- The format will NOT write an ``Index``, or ``MultiIndex`` for the ``DataFrame`` and will raise an
4537-
error if a non-default one is provided. You can simply ``.reset_index(drop=True)`` in order to store the index.
4538+
- The format will NOT write an ``Index``, or ``MultiIndex`` for the
4539+
``DataFrame`` and will raise an error if a non-default one is provided. You
4540+
can ``.reset_index()`` to store the index or ``.reset_index(drop=True)`` to
4541+
ignore it.
45384542
- Duplicate column names and non-string columns names are not supported
45394543
- Categorical dtypes can be serialized to parquet, but will de-serialize as ``object`` dtype.
45404544
- Non supported types include ``Period`` and actual python object types. These will raise a helpful error message
@@ -4580,7 +4584,7 @@ Read from a parquet file.
45804584
45814585
result.dtypes
45824586
4583-
Read only certain columns of a parquet file.
4587+
Read only certain columns of a parquet file.
45844588

45854589
.. ipython:: python
45864590

0 commit comments

Comments
 (0)