Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.walk #58386

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 23, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.walk #58386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f744d9f
DOC: add SA01 to HDFStore.walk
tuhinsharma121 Apr 23, 2024
c696001
DOC: remove SA01 of HDFStore.walk
tuhinsharma121 Apr 23, 2024
c68abf9
Merge remote-tracking branch 'upstream/main' into numpy-docstring-hdf…
tuhinsharma121 Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DatetimeTZDtype.tz SA01" \
-i "pandas.DatetimeTZDtype.unit SA01" \
-i "pandas.Grouper PR02" \
-i "pandas.HDFStore.walk SA01" \
-i "pandas.Index PR07" \
-i "pandas.Index.T SA01" \
-i "pandas.Index.append PR07,RT03,SA01" \
Expand Down
4 changes: 4 additions & 0 deletions pandas/io/pytables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1595,6 +1595,10 @@ def walk(self, where: str = "/") -> Iterator[tuple[str, list[str], list[str]]]:
leaves : list
Names (strings) of the pandas objects contained in `path`.

See Also
--------
HDFStore.info : Prints detailed information on the store.

Examples
--------
>>> df1 = pd.DataFrame([[1, 2], [3, 4]], columns=["A", "B"])
Expand Down