Skip to content

Doc: fix PR07 errors in DatetimeIndex - indexer_between_time, mean and HDFStore - append, get, put #57805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -499,11 +499,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

MSG='Partially validate docstrings (PR07)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR07 --ignore_functions \
pandas.DatetimeIndex.indexer_between_time\
pandas.DatetimeIndex.mean\
pandas.HDFStore.append\
pandas.HDFStore.get\
pandas.HDFStore.put\
pandas.Index\
pandas.Index.append\
pandas.Index.copy\
Expand Down
1 change: 1 addition & 0 deletions pandas/core/arrays/datetimelike.py
Original file line number Diff line number Diff line change
Expand Up @@ -1577,6 +1577,7 @@ def mean(self, *, skipna: bool = True, axis: AxisInt | None = 0):
skipna : bool, default True
Whether to ignore any NaT elements.
axis : int, optional, default 0
Axis for the function to be applied on.

Returns
-------
Expand Down
2 changes: 2 additions & 0 deletions pandas/core/indexes/datetimes.py
Original file line number Diff line number Diff line change
Expand Up @@ -774,7 +774,9 @@ def indexer_between_time(
appropriate format ("%H:%M", "%H%M", "%I:%M%p", "%I%M%p",
"%H:%M:%S", "%H%M%S", "%I:%M:%S%p","%I%M%S%p").
include_start : bool, default True
Include boundaries; whether to set start bound as closed or open.
include_end : bool, default True
Include boundaries; whether to set end bound as closed or open.

Returns
-------
Expand Down
20 changes: 15 additions & 5 deletions pandas/io/pytables.py
Original file line number Diff line number Diff line change
Expand Up @@ -779,6 +779,7 @@ def get(self, key: str):
Parameters
----------
key : str
Object to retrieve from file. Raises KeyError if not found.

Returns
-------
Expand Down Expand Up @@ -1110,7 +1111,9 @@ def put(
Parameters
----------
key : str
Key of object to store in file.
value : {Series, DataFrame}
Value of object to store in file.
format : 'fixed(f)|table(t)', default is 'fixed'
Format to use when storing object in HDFStore. Value can be one of:

Expand Down Expand Up @@ -1248,7 +1251,9 @@ def append(
Parameters
----------
key : str
Key of object to append.
value : {Series, DataFrame}
Value of object to append.
format : 'table' is the default
Format to use when storing object in HDFStore. Value can be one of:

Expand All @@ -1265,11 +1270,16 @@ def append(
queries, or True to use all columns. By default only the axes
of the object are indexed. See `here
<https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#query-via-data-columns>`__.
min_itemsize : dict of columns that specify minimum str sizes
nan_rep : str to use as str nan representation
chunksize : size to chunk the writing
expectedrows : expected TOTAL row size of this table
encoding : default None, provide an encoding for str
min_itemsize : int, dict, or None
Dict of columns that specify minimum str sizes.
nan_rep : str
Str to use as str nan representation.
chunksize : int or None
Size to chunk the writing.
expectedrows : int
Expected TOTAL row size of this table.
encoding : default None
Provide an encoding for str.
dropna : bool, default False, optional
Do not write an ALL nan row to the store settable
by the option 'io.hdf.dropna_table'.
Expand Down