Skip to content

Commit c2c04a2

Browse files
jordan-d-murphypmhatre1
authored andcommitted
Doc: fix PR07 errors in DatetimeIndex - indexer_between_time, mean and HDFStore - append, get, put (pandas-dev#57805)
fix PR07 errors in DatetimeIndex - indexer_between_time, mean and HDFStore - append, get, put
1 parent 4e5ce40 commit c2c04a2

File tree

4 files changed

+18
-10
lines changed

4 files changed

+18
-10
lines changed

ci/code_checks.sh

-5
Original file line numberDiff line numberDiff line change
@@ -499,11 +499,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
499499

500500
MSG='Partially validate docstrings (PR07)' ; echo $MSG
501501
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR07 --ignore_functions \
502-
pandas.DatetimeIndex.indexer_between_time\
503-
pandas.DatetimeIndex.mean\
504-
pandas.HDFStore.append\
505-
pandas.HDFStore.get\
506-
pandas.HDFStore.put\
507502
pandas.Index\
508503
pandas.Index.append\
509504
pandas.Index.copy\

pandas/core/arrays/datetimelike.py

+1
Original file line numberDiff line numberDiff line change
@@ -1577,6 +1577,7 @@ def mean(self, *, skipna: bool = True, axis: AxisInt | None = 0):
15771577
skipna : bool, default True
15781578
Whether to ignore any NaT elements.
15791579
axis : int, optional, default 0
1580+
Axis for the function to be applied on.
15801581
15811582
Returns
15821583
-------

pandas/core/indexes/datetimes.py

+2
Original file line numberDiff line numberDiff line change
@@ -774,7 +774,9 @@ def indexer_between_time(
774774
appropriate format ("%H:%M", "%H%M", "%I:%M%p", "%I%M%p",
775775
"%H:%M:%S", "%H%M%S", "%I:%M:%S%p","%I%M%S%p").
776776
include_start : bool, default True
777+
Include boundaries; whether to set start bound as closed or open.
777778
include_end : bool, default True
779+
Include boundaries; whether to set end bound as closed or open.
778780
779781
Returns
780782
-------

pandas/io/pytables.py

+15-5
Original file line numberDiff line numberDiff line change
@@ -779,6 +779,7 @@ def get(self, key: str):
779779
Parameters
780780
----------
781781
key : str
782+
Object to retrieve from file. Raises KeyError if not found.
782783
783784
Returns
784785
-------
@@ -1110,7 +1111,9 @@ def put(
11101111
Parameters
11111112
----------
11121113
key : str
1114+
Key of object to store in file.
11131115
value : {Series, DataFrame}
1116+
Value of object to store in file.
11141117
format : 'fixed(f)|table(t)', default is 'fixed'
11151118
Format to use when storing object in HDFStore. Value can be one of:
11161119
@@ -1248,7 +1251,9 @@ def append(
12481251
Parameters
12491252
----------
12501253
key : str
1254+
Key of object to append.
12511255
value : {Series, DataFrame}
1256+
Value of object to append.
12521257
format : 'table' is the default
12531258
Format to use when storing object in HDFStore. Value can be one of:
12541259
@@ -1265,11 +1270,16 @@ def append(
12651270
queries, or True to use all columns. By default only the axes
12661271
of the object are indexed. See `here
12671272
<https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#query-via-data-columns>`__.
1268-
min_itemsize : dict of columns that specify minimum str sizes
1269-
nan_rep : str to use as str nan representation
1270-
chunksize : size to chunk the writing
1271-
expectedrows : expected TOTAL row size of this table
1272-
encoding : default None, provide an encoding for str
1273+
min_itemsize : int, dict, or None
1274+
Dict of columns that specify minimum str sizes.
1275+
nan_rep : str
1276+
Str to use as str nan representation.
1277+
chunksize : int or None
1278+
Size to chunk the writing.
1279+
expectedrows : int
1280+
Expected TOTAL row size of this table.
1281+
encoding : default None
1282+
Provide an encoding for str.
12731283
dropna : bool, default False, optional
12741284
Do not write an ALL nan row to the store settable
12751285
by the option 'io.hdf.dropna_table'.

0 commit comments

Comments
 (0)