Skip to content

Commit

Permalink
DOC: Enforce Numpy Docstring Validation for pandas.DataFrame.attime (#…
Browse files Browse the repository at this point in the history
…58492)

* DOC: add SA01PR01 in pandas.DataFrame.at_time

* DOC: remove PR01 in pandas.DataFrame.at_time

* DOC: remove pandas.Series.at_time
  • Loading branch information
tuhinsharma121 committed Apr 30, 2024
1 parent c9bc480 commit cb8b213
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 0 additions & 2 deletions ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
--format=actions \
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
-i "pandas.Series.dt PR01" `# Accessors are implemented as classes, but we do not document the Parameters section` \
-i "pandas.DataFrame.at_time PR01" \
-i "pandas.DataFrame.max RT03" \
-i "pandas.DataFrame.mean RT03,SA01" \
-i "pandas.DataFrame.median RT03,SA01" \
Expand Down Expand Up @@ -187,7 +186,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series SA01" \
-i "pandas.Series.__iter__ RT03,SA01" \
-i "pandas.Series.add PR07" \
-i "pandas.Series.at_time PR01" \
-i "pandas.Series.backfill PR01,SA01" \
-i "pandas.Series.case_when RT03" \
-i "pandas.Series.cat PR07,SA01" \
Expand Down
2 changes: 2 additions & 0 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -8532,6 +8532,8 @@ def at_time(self, time, asof: bool = False, axis: Axis | None = None) -> Self:
----------
time : datetime.time or str
The values to select.
asof : bool, default False
This parameter is currently not supported.
axis : {0 or 'index', 1 or 'columns'}, default 0
For `Series` this parameter is unused and defaults to 0.
Expand Down

0 comments on commit cb8b213

Please sign in to comment.