Skip to content

Add clarifications to the docs regarding to_feather #43866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jreback merged 2 commits into from
Oct 7, 2021
Merged

Add clarifications to the docs regarding to_feather #43866

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcd29d0
Add clarifications to the docs
jmakov Oct 3, 2021
3a403a5
Add notes section
jmakov Oct 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2564,6 +2564,13 @@ def to_feather(self, path: FilePathOrBuffer[AnyStr], **kwargs) -> None:
`compression_level`, `chunksize` and `version` keywords.

.. versionadded:: 1.1.0

Notes
-----
This function writes the dataframe as a `feather file
<https://arrow.apache.org/docs/python/feather.html>`_. Requires a default
index. For saving the DataFrame with your custom index use a method that
supports custom indices e.g. `to_parquet`.
"""
from pandas.io.feather_format import to_feather

Expand Down