Skip to content

Commit 281d4a8

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.keys (#58371)
* DOC: add SA01 to HDFStore.keys * DOC: remove HDFStore.keys * DOC: fix typo in See Also for HDFStore.keys
1 parent cf953da commit 281d4a8

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
122122
-i "pandas.DatetimeTZDtype.tz SA01" \
123123
-i "pandas.DatetimeTZDtype.unit SA01" \
124124
-i "pandas.Grouper PR02" \
125-
-i "pandas.HDFStore.keys SA01" \
126125
-i "pandas.HDFStore.put PR01,SA01" \
127126
-i "pandas.HDFStore.select SA01" \
128127
-i "pandas.HDFStore.walk SA01" \

pandas/io/pytables.py

+6
Original file line numberDiff line numberDiff line change
@@ -656,6 +656,12 @@ def keys(self, include: str = "pandas") -> list[str]:
656656
------
657657
raises ValueError if kind has an illegal value
658658
659+
See Also
660+
--------
661+
HDFStore.info : Prints detailed information on the store.
662+
HDFStore.get_node : Returns the node with the key.
663+
HDFStore.get_storer : Returns the storer object for a key.
664+
659665
Examples
660666
--------
661667
>>> df = pd.DataFrame([[1, 2], [3, 4]], columns=["A", "B"])

0 commit comments

Comments
 (0)