DOC: update DataFrame.to_feather docstring #35408
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arw2019
force-pushed
the
to-feather-api-docs
branch
2 times, most recently
from
f2fb477 to
5a3d562
Compare
arw2019
force-pushed
the
to-feather-api-docs
branch
from
5a3d562 to
9cbc3e8
Compare
pandas/core/frame.py
Outdated
| 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. |
Member
There was a problem hiding this comment.
do we describe what file-like means elsewhere? id be ok with leaving that out.
backticks around io.BytesIO
Contributor
Author
There was a problem hiding this comment.
we do describe it in other writer methods and in the user guide - I took it out (fb37d73)
Contributor
Author
jreback
requested changes
Sep 8, 2020
Member
|
LGTM |
jreback
approved these changes
Sep 13, 2020
Contributor
|
thanks @arw2019 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diffThe issue was that
DataFrame.to_featherhad anfnameargument which in fact could be either a filename or a buffer. Most of the work to close #29532 was done in #30338 wherefnameargument was deprecated in favor ofpath. Here I update the docstring to let users know that they can use a buffer.