Skip to content

DOC: fix docstring validation errors for pandas.Timestamp as part of Issue #59458 #59468

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

Closed
wants to merge 3 commits into from
Closed

DOC: fix docstring validation errors for pandas.Timestamp as part of Issue #59458 #59468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73375e7
added see also to Timestamp.month_name()
josh-tan77 Aug 10, 2024
487c6b8
added see also to Timestamp.quarter()
josh-tan77 Aug 10, 2024
d362c83
removed Timestamp.quarter() and Timestamp.month_name() after fixing d…
josh-tan77 Aug 10, 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: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,10 +216,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Timestamp.min PR02" \
-i "pandas.Timestamp.minute GL08" \
-i "pandas.Timestamp.month GL08" \
-i "pandas.Timestamp.month_name SA01" \
-i "pandas.Timestamp.nanosecond GL08" \
-i "pandas.Timestamp.normalize SA01" \
-i "pandas.Timestamp.quarter SA01" \
-i "pandas.Timestamp.replace PR07,SA01" \
-i "pandas.Timestamp.resolution PR02" \
-i "pandas.Timestamp.second GL08" \
Expand Down
9 changes: 9 additions & 0 deletions pandas/_libs/tslibs/timestamps.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,6 +802,10 @@ cdef class _Timestamp(ABCTimestamp):
-------
str

See Also
--------
Timestamp.day_name : Return the day name of the Timestamp with specified locale.

Examples
--------
>>> ts = pd.Timestamp('2020-03-14T15:32:52.192548651')
Expand Down Expand Up @@ -896,6 +900,11 @@ cdef class _Timestamp(ABCTimestamp):
-------
int

See Also
--------
Timestamp.is_quarter_end : Check if date is last day of the quarter.
Timestamp.is_quarter_start : Check if the date is the first day of the quarter.

Examples
--------
>>> ts = pd.Timestamp(2020, 3, 14)
Expand Down
Loading