Skip to content

Commit ae2a3e9

Browse files
tuhinsharma121pmhatre1
authored andcommitted
DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.select (pandas-dev#58374)
* DOC: add SA01 to HDFStore.select * DOC: remove HDFStore.select
1 parent 847ee00 commit ae2a3e9

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.unit SA01" \
123123
-i "pandas.Grouper PR02" \
124124
-i "pandas.HDFStore.put PR01,SA01" \
125-
-i "pandas.HDFStore.select SA01" \
126125
-i "pandas.HDFStore.walk SA01" \
127126
-i "pandas.Index PR07" \
128127
-i "pandas.Index.T SA01" \

pandas/io/pytables.py

+6
Original file line numberDiff line numberDiff line change
@@ -859,6 +859,12 @@ def select(
859859
object
860860
Retrieved object from file.
861861
862+
See Also
863+
--------
864+
HDFStore.select_as_coordinates : Returns the selection as an index.
865+
HDFStore.select_column : Returns a single column from the table.
866+
HDFStore.select_as_multiple : Retrieves pandas objects from multiple tables.
867+
862868
Examples
863869
--------
864870
>>> df = pd.DataFrame([[1, 2], [3, 4]], columns=["A", "B"])

0 commit comments

Comments
 (0)