Skip to content

DOC: update DataFrame.to_feather docstring #35408

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
merged 7 commits into from
Sep 13, 2020
Merged

DOC: update DataFrame.to_feather docstring #35408

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9cbc3e8
rebase + add some more details to doc
arw2019 Aug 1, 2020
13a0cca
Merge remote-tracking branch 'upstream/master' into to-feather-api-docs
arw2019 Aug 3, 2020
7e7f832
Merge with master
arw2019 Aug 19, 2020
fb37d73
fixed docstring
arw2019 Aug 19, 2020
3ca46c1
Merge remote-tracking branch 'upstream/master' into to-feather-api-docs
arw2019 Sep 8, 2020
3b8e068
feedback
arw2019 Sep 8, 2020
9522751
add import
arw2019 Sep 8, 2020
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
6 changes: 4 additions & 2 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2199,8 +2199,10 @@ def to_feather(self, path, **kwargs) -> None:

Parameters
----------
path : str
String file path.
path : str or file-like object
If a string, it will be used as Root Directory path. By file-like
object, we refer to objects with a write() method, such as
a file handler (e.g. via builtin open function) or io.BytesIO.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we describe what file-like means elsewhere? id be ok with leaving that out.

backticks around io.BytesIO

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we do describe it in other writer methods and in the user guide - I took it out (fb37d73)

**kwargs :
Additional keywords passed to :func:`pyarrow.feather.write_feather`.
Starting with pyarrow 0.17, this includes the `compression`,
Expand Down