Skip to content

Commit 4afc277

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.get (#58341)
* DOC: added see also section for HDFStore.get * DOC: removed HDFStore.get
1 parent 7cafc21 commit 4afc277

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
134134
-i "pandas.DatetimeTZDtype.tz SA01" \
135135
-i "pandas.DatetimeTZDtype.unit SA01" \
136136
-i "pandas.Grouper PR02" \
137-
-i "pandas.HDFStore.get SA01" \
138137
-i "pandas.HDFStore.groups SA01" \
139138
-i "pandas.HDFStore.info RT03,SA01" \
140139
-i "pandas.HDFStore.keys SA01" \

pandas/io/pytables.py

+5
Original file line numberDiff line numberDiff line change
@@ -786,6 +786,11 @@ def get(self, key: str):
786786
object
787787
Same type as object stored in file.
788788
789+
See Also
790+
--------
791+
HDFStore.get_node : Returns the node with the key.
792+
HDFStore.get_storer : Returns the storer object for a key.
793+
789794
Examples
790795
--------
791796
>>> df = pd.DataFrame([[1, 2], [3, 4]], columns=["A", "B"])

0 commit comments

Comments
 (0)