Skip to content

Commit d4ae657

Browse files
jmakovrhshadrach
authored andcommitted
Add clarifications to the docs regarding to_feather (pandas-dev#43866)
1 parent 4779171 commit d4ae657

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

pandas/core/frame.py

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

0 commit comments

Comments
 (0)