Skip to content

Commit 9f7e89e

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.HDFStore.append (#58305)
* fixed PR01,SA01 in docstring for pandas.HDFStore.append * removed method pandas.HDFStore.append * changed default value to None * commented out from complib onwards * restored complib * commented out half of complib * commented out set from complib * changed the type of complib * uncommented all other parameters * removed # * changed default value to None * changed default value to None * deleted client.py
1 parent 5281e0e commit 9f7e89e

File tree

2 files changed

+26
-8
lines changed

2 files changed

+26
-8
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
134134
-i "pandas.DatetimeTZDtype.tz SA01" \
135135
-i "pandas.DatetimeTZDtype.unit SA01" \
136136
-i "pandas.Grouper PR02" \
137-
-i "pandas.HDFStore.append PR01,SA01" \
138137
-i "pandas.HDFStore.get SA01" \
139138
-i "pandas.HDFStore.groups SA01" \
140139
-i "pandas.HDFStore.info RT03,SA01" \

pandas/io/pytables.py

+26-7
Original file line numberDiff line numberDiff line change
@@ -1261,15 +1261,19 @@ def append(
12611261
Table format. Write as a PyTables Table structure which may perform
12621262
worse but allow more flexible operations like searching / selecting
12631263
subsets of the data.
1264+
axes : default None
1265+
This parameter is currently not accepted.
12641266
index : bool, default True
12651267
Write DataFrame index as a column.
12661268
append : bool, default True
12671269
Append the input data to the existing.
1268-
data_columns : list of columns, or True, default None
1269-
List of columns to create as indexed data columns for on-disk
1270-
queries, or True to use all columns. By default only the axes
1271-
of the object are indexed. See `here
1272-
<https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#query-via-data-columns>`__.
1270+
complib : default None
1271+
This parameter is currently not accepted.
1272+
complevel : int, 0-9, default None
1273+
Specifies a compression level for data.
1274+
A value of 0 or None disables compression.
1275+
columns : default None
1276+
This parameter is currently not accepted, try data_columns.
12731277
min_itemsize : int, dict, or None
12741278
Dict of columns that specify minimum str sizes.
12751279
nan_rep : str
@@ -1278,11 +1282,26 @@ def append(
12781282
Size to chunk the writing.
12791283
expectedrows : int
12801284
Expected TOTAL row size of this table.
1281-
encoding : default None
1282-
Provide an encoding for str.
12831285
dropna : bool, default False, optional
12841286
Do not write an ALL nan row to the store settable
12851287
by the option 'io.hdf.dropna_table'.
1288+
data_columns : list of columns, or True, default None
1289+
List of columns to create as indexed data columns for on-disk
1290+
queries, or True to use all columns. By default only the axes
1291+
of the object are indexed. See `here
1292+
<https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#query-via-data-columns>`__.
1293+
encoding : default None
1294+
Provide an encoding for str.
1295+
errors : str, default 'strict'
1296+
The error handling scheme to use for encoding errors.
1297+
The default is 'strict' meaning that encoding errors raise a
1298+
UnicodeEncodeError. Other possible values are 'ignore', 'replace' and
1299+
'xmlcharrefreplace' as well as any other name registered with
1300+
codecs.register_error that can handle UnicodeEncodeErrors.
1301+
1302+
See Also
1303+
--------
1304+
HDFStore.append_to_multiple : Append to multiple tables.
12861305
12871306
Notes
12881307
-----

0 commit comments

Comments
 (0)