Skip to content

Commit 4c03eb6

Browse files
tuhinsharma121pmhatre1
authored andcommitted
DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.put (pandas-dev#58384)
* DOC: add SA01 and PR01 to HDFStore.put * DOC: remove SA01 and PR01 of HDFStore.put
1 parent fc187b6 commit 4c03eb6

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

ci/code_checks.sh

-1
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.put PR01,SA01" \
122121
-i "pandas.HDFStore.walk SA01" \
123122
-i "pandas.Index PR07" \
124123
-i "pandas.Index.T SA01" \

pandas/io/pytables.py

+20
Original file line numberDiff line numberDiff line change
@@ -1144,19 +1144,39 @@ def put(
11441144
Write DataFrame index as a column.
11451145
append : bool, default False
11461146
This will force Table format, append the input data to the existing.
1147+
complib : default None
1148+
This parameter is currently not accepted.
1149+
complevel : int, 0-9, default None
1150+
Specifies a compression level for data.
1151+
A value of 0 or None disables compression.
1152+
min_itemsize : int, dict, or None
1153+
Dict of columns that specify minimum str sizes.
1154+
nan_rep : str
1155+
Str to use as str nan representation.
11471156
data_columns : list of columns or True, default None
11481157
List of columns to create as data columns, or True to use all columns.
11491158
See `here
11501159
<https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#query-via-data-columns>`__.
11511160
encoding : str, default None
11521161
Provide an encoding for strings.
1162+
errors : str, default 'strict'
1163+
The error handling scheme to use for encoding errors.
1164+
The default is 'strict' meaning that encoding errors raise a
1165+
UnicodeEncodeError. Other possible values are 'ignore', 'replace' and
1166+
'xmlcharrefreplace' as well as any other name registered with
1167+
codecs.register_error that can handle UnicodeEncodeErrors.
11531168
track_times : bool, default True
11541169
Parameter is propagated to 'create_table' method of 'PyTables'.
11551170
If set to False it enables to have the same h5 files (same hashes)
11561171
independent on creation time.
11571172
dropna : bool, default False, optional
11581173
Remove missing values.
11591174
1175+
See Also
1176+
--------
1177+
HDFStore.info : Prints detailed information on the store.
1178+
HDFStore.get_storer : Returns the storer object for a key.
1179+
11601180
Examples
11611181
--------
11621182
>>> df = pd.DataFrame([[1, 2], [3, 4]], columns=["A", "B"])

0 commit comments

Comments
 (0)