DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.groups (p…

…andas-dev#58357) * DOC: added SA01 to HDFStore.groups * DOC: removed HDFStore.groups
pmhatre1 · May 7, 2024 · 53421e8 · 53421e8
1 parent d25ba0b
commit 53421e8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -131,7 +131,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.DatetimeTZDtype.tz SA01" \
         -i "pandas.DatetimeTZDtype.unit SA01" \
         -i "pandas.Grouper PR02" \
-        -i "pandas.HDFStore.groups SA01" \
         -i "pandas.HDFStore.info RT03,SA01" \
         -i "pandas.HDFStore.keys SA01" \
         -i "pandas.HDFStore.put PR01,SA01" \

diff --git a/pandas/io/pytables.py b/pandas/io/pytables.py
@@ -1504,6 +1504,10 @@ def groups(self) -> list:
         list
             List of objects.
 
+        See Also
+        --------
+        HDFStore.get_node : Returns the node with the key.
+
         Examples
         --------
         >>> df = pd.DataFrame([[1, 2], [3, 4]], columns=["A", "B"])