DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.info #58368
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
Contributor
tuhinsharma121
commented
Apr 22, 2024
tuhinsharma121
commented
- xref DOC: Enforce Numpy Docstring Validation | pandas.ExcelFile through pandas.HDFStore #58067
tuhinsharma121
commented
Apr 22, 2024
Comment on lines
1697
to
1711
|
|
||
| Examples | ||
| -------- | ||
| >>> df = pd.DataFrame([[1, 2], [3, 4]], columns=["A", "B"]) | ||
| >>> df1 = pd.DataFrame([[1, 2], [3, 4]], columns=["A", "B"]) | ||
| >>> df2 = pd.DataFrame([[5, 6], [7, 8]], columns=["C", "D"]) | ||
| >>> store = pd.HDFStore("store.h5", "w") # doctest: +SKIP | ||
| >>> store.put("data", df) # doctest: +SKIP | ||
| >>> store.put("data1", df1) # doctest: +SKIP | ||
| >>> store.put("data2", df2) # doctest: +SKIP | ||
| >>> print(store.info()) # doctest: +SKIP | ||
| >>> store.close() # doctest: +SKIP | ||
| <class 'pandas.io.pytables.HDFStore'> | ||
| File path: store.h5 | ||
| /data frame (shape->[2,2]) | ||
| /data1 frame (shape->[2,2]) | ||
| /data2 frame (shape->[2,2]) | ||
| """ |
There was a problem hiding this comment.
@mroeschke I took the liberty to refine the example by adding one more dataframe. Let me know if this is good or I need to revert back.
tuhinsharma121
commented
Apr 22, 2024
Comment on lines
+1693
to
1697
|
|
||
| See Also | ||
| -------- | ||
| HDFStore.get_storer : Returns the storer object for a key. | ||
|
|
There was a problem hiding this comment.
@mroeschke I could not find a closer method than this.
tuhinsharma121
changed the title
mroeschke
approved these changes
Apr 22, 2024
|
Thanks @tuhinsharma121 |
kvnwng11
pushed a commit
to kvnwng11/pandas
that referenced
this pull request
Apr 22, 2024
…das-dev#58368) * DOC: add return description and see also section to pandas.HDFStore.info * DOC: add 2 df in the examples for pandas.HDFStore.info * DOC: remove pandas.HDFStore.info
pmhatre1
pushed a commit
to pmhatre1/pandas-pmhatre1
that referenced
this pull request
May 7, 2024
…das-dev#58368) * DOC: add return description and see also section to pandas.HDFStore.info * DOC: add 2 df in the examples for pandas.HDFStore.info * DOC: remove pandas.HDFStore.info
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.