Skip to content

Commit 0d2d500

Browse files
authored
Add clarifications to the docs regarding to_feather (#43866)
1 parent 42a6604 commit 0d2d500

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

pandas/core/frame.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2564,6 +2564,13 @@ def to_feather(self, path: FilePathOrBuffer[AnyStr], **kwargs) -> None:
25642564
`compression_level`, `chunksize` and `version` keywords.
25652565
25662566
.. versionadded:: 1.1.0
2567+
2568+
Notes
2569+
-----
2570+
This function writes the dataframe as a `feather file
2571+
<https://arrow.apache.org/docs/python/feather.html>`_. Requires a default
2572+
index. For saving the DataFrame with your custom index use a method that
2573+
supports custom indices e.g. `to_parquet`.
25672574
"""
25682575
from pandas.io.feather_format import to_feather
25692576

0 commit comments

Comments
 (0)