DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.get (#58341)

* DOC: added see also section for HDFStore.get * DOC: removed HDFStore.get
pandas-dev · Apr 20, 2024 · 4afc277 · 4afc277
1 parent 7cafc21
commit 4afc277
Show file tree

Hide file tree

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

diff --git a/pandas/io/pytables.py b/pandas/io/pytables.py
@@ -786,6 +786,11 @@ def get(self, key: str):
         object
             Same type as object stored in file.
 
+        See Also
+        --------
+        HDFStore.get_node : Returns the node with the key.
+        HDFStore.get_storer : Returns the storer object for a key.
+
         Examples
         --------
         >>> df = pd.DataFrame([[1, 2], [3, 4]], columns=["A", "B"])