Skip to content

DOC: NDFrame.to_hdf(data_columns) documented (#13061). #13951

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.

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

Closed
wants to merge 1 commit into from

Conversation

jzwinck
Copy link
Contributor

@jzwinck jzwinck commented Aug 9, 2016

I'm aware there's another PR for the same issue, but it hasn't had activity in a while so this is my attempt. I took the opportunity to remove the unusable "mode=r" option from the same docstring, and make the title clearer.

@jreback jreback added the Docs label Aug 9, 2016
@jreback jreback added this to the 0.19.0 milestone Aug 9, 2016
@jreback jreback added the IO HDF5 read_hdf, HDFStore label Aug 9, 2016
@@ -1126,7 +1124,9 @@ def to_hdf(self, path_or_buf, key, **kwargs):
If applying compression use the fletcher32 checksum
dropna : boolean, default False.
If true, ALL nan rows will not be written to store.

data_columns : list of columns to create as data columns, or True to
use all columns. If True and format='table', data will be written
Copy link
Contributor

Choose a reason for hiding this comment

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

this last line is superfluous. This and HDFStore.append for data_columns should be the same. pls add a link to the docs in both.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jreback Can you clarify what you mean by "add a link to the docs in both"?

Copy link
Contributor

Choose a reason for hiding this comment

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

a ref to: http://pandas.pydata.org/pandas-docs/stable/io.html#query-via-data-columns

and ideally adding references as needed (e.g. compression) and for the format option

@codecov-io
Copy link

codecov-io commented Aug 9, 2016

Current coverage is 85.25% (diff: 100%)

Merging #13951 into master will not change coverage

@@             master     #13951   diff @@
==========================================
  Files           139        139          
  Lines         50381      50381          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits          42953      42953          
  Misses         7428       7428          
  Partials          0          0          

Powered by Codecov. Last update a01e58f...cfcca2f

@jorisvandenbossche jorisvandenbossche removed this from the 0.19.0 milestone Aug 15, 2016
@jzwinck
Copy link
Contributor Author

jzwinck commented Aug 19, 2016

@jreback Can you review this again? I've updated it as per your previous comments.

@jreback jreback added this to the 0.19.0 milestone Aug 19, 2016
@jreback jreback closed this in 453bc26 Aug 19, 2016
@jreback
Copy link
Contributor

jreback commented Aug 19, 2016

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO HDF5 read_hdf, HDFStore
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: DataFrame.to_hdf() docstring does not mention data_columns
4 participants