Skip to content

Commit ffca684

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.walk (#58386)
* DOC: add SA01 to HDFStore.walk * DOC: remove SA01 of HDFStore.walk
1 parent 23dd1f1 commit ffca684

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
118118
-i "pandas.DatetimeTZDtype.tz SA01" \
119119
-i "pandas.DatetimeTZDtype.unit SA01" \
120120
-i "pandas.Grouper PR02" \
121-
-i "pandas.HDFStore.walk SA01" \
122121
-i "pandas.Index PR07" \
123122
-i "pandas.Index.T SA01" \
124123
-i "pandas.Index.append PR07,RT03,SA01" \

pandas/io/pytables.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1595,6 +1595,10 @@ def walk(self, where: str = "/") -> Iterator[tuple[str, list[str], list[str]]]:
15951595
leaves : list
15961596
Names (strings) of the pandas objects contained in `path`.
15971597
1598+
See Also
1599+
--------
1600+
HDFStore.info : Prints detailed information on the store.
1601+
15981602
Examples
15991603
--------
16001604
>>> df1 = pd.DataFrame([[1, 2], [3, 4]], columns=["A", "B"])

0 commit comments

Comments
 (0)