Skip to content
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

DOC: Fix read_hdf docstring #20874

Merged
merged 3 commits into from
Apr 30, 2018
Merged

Conversation

bashtage
Copy link
Contributor

Read HDF docstring was not in NumPy format. Corrects the formatting

[skip ci]

  • passes git diff upstream/master -u -- "*.py" | flake8 --diff

@bashtage
Copy link
Contributor Author

The rendered docstring

https://pandas.pydata.org/pandas-docs/stable/generated/pandas.read_hdf.html

does not have the correct appearance.

@jreback jreback added Docs IO HDF5 read_hdf, HDFStore labels Apr 30, 2018
@jreback jreback added this to the 0.23.0 milestone Apr 30, 2018
@jreback
Copy link
Contributor

jreback commented Apr 30, 2018

can you run the validation script on this?

Read HDF docstring was not in NumPy format.  Corrects the formatting

[skip ci]
@bashtage
Copy link
Contributor Author

Seems inevitable since signature uses **kwargs to capture most inputs.

Errors found:
        Errors in parameters section
                Unknown parameters {'iterator', 'start', 'chunksize', 'where', 'columns', 'stop '}

@TomAugspurger TomAugspurger mentioned this pull request Apr 30, 2018
71 tasks
@TomAugspurger
Copy link
Contributor

CI wasn't running, pushed a commit w/ a few small changes (mentioning __fspath__) to re-trigger it.

@TomAugspurger
Copy link
Contributor

Merging since the doc build passed cleanly.

@TomAugspurger TomAugspurger merged commit 70468df into pandas-dev:master Apr 30, 2018
@bashtage bashtage deleted the doc-read-hdf branch June 2, 2018 10:33
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.

3 participants