Skip to content

DOC: fixing GL08 errors for pandas.Series.dt #57751

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.

Sign up for GitHub

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 11 commits into from
Mar 17, 2024
Merged

DOC: fixing GL08 errors for pandas.Series.dt #57751

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
16f7e91
fix GL08 error and write docstring for pandas.Series.dt
s1099 Mar 6, 2024
dfd9edf
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 6, 2024
429f405
update docstring with parameters
s1099 Mar 7, 2024
f841e72
Merge branch 'GL08-errors' of https://github.com/s1099/pandas into GL…
s1099 Mar 7, 2024
194b97e
format docstring and remove from validate docstring ignore
s1099 Mar 7, 2024
ce22259
Merge branch 'pandas-dev:main' into GL08-errors
s1099 Mar 16, 2024
7af2579
Remove parameters, returns and add reference
s1099 Mar 16, 2024
956ba90
remove Raises, Notes and update description
s1099 Mar 16, 2024
8df8041
make it pass ci checks
s1099 Mar 16, 2024
b4dea45
update see also
s1099 Mar 16, 2024
5c1b243
Update ci/code_checks.sh
s1099 Mar 16, 2024
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
2 changes: 1 addition & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.Period.ordinal\
pandas.PeriodIndex.freq\
pandas.PeriodIndex.qyear\
pandas.Series.dt\
pandas.Series.dt.as_unit\
pandas.Series.dt.freq\
pandas.Series.dt.qyear\
Expand Down Expand Up @@ -437,6 +436,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.Series.cat.rename_categories\
pandas.Series.cat.reorder_categories\
pandas.Series.cat.set_categories\
pandas.Series.dt\
pandas.Series.dt.as_unit\
pandas.Series.dt.ceil\
pandas.Series.dt.day_name\
Expand Down
38 changes: 38 additions & 0 deletions pandas/core/indexes/accessors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,6 +572,44 @@ class PeriodProperties(Properties):
class CombinedDatetimelikeProperties(
DatetimeProperties, TimedeltaProperties, PeriodProperties
):
"""
Accessor object for Series values' datetime-like, timedelta and period properties.

See Also
--------
Series.dt : Accessor object for datetimelike properties of the Series values.

Examples
--------
>>> dates = pd.Series(
... ["2024-01-01", "2024-01-15", "2024-02-5"], dtype="datetime64[ns]"
... )
>>> dates.dt.day
0 1
1 15
2 5
dtype: int32
>>> dates.dt.month
0 1
1 1
2 2
dtype: int32

>>> dates = pd.Series(
... ["2024-01-01", "2024-01-15", "2024-02-5"], dtype="datetime64[ns, UTC]"
... )
>>> dates.dt.day
0 1
1 15
2 5
dtype: int32
>>> dates.dt.month
0 1
1 1
2 2
dtype: int32
"""

def __new__(cls, data: Series): # pyright: ignore[reportInconsistentConstructor]
# CombinedDatetimelikeProperties isn't really instantiated. Instead
# we need to choose which parent (datetime or timedelta) is
Expand Down