Skip to content

Commit 74ca7cd

Browse files
DOC: add SA01 for pandas.Timestamp.isocalendar (#58763)
* DOC: add SA01 for pandas.Timestamp.isocalendar * DOC: remove SA01 for pandas.Timestamp.isocalendar
1 parent a3e751c commit 74ca7cd

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
256256
-i "pandas.Timestamp.fromordinal SA01" \
257257
-i "pandas.Timestamp.fromtimestamp PR01,SA01" \
258258
-i "pandas.Timestamp.hour GL08" \
259-
-i "pandas.Timestamp.isocalendar SA01" \
260259
-i "pandas.Timestamp.isoweekday SA01" \
261260
-i "pandas.Timestamp.max PR02" \
262261
-i "pandas.Timestamp.microsecond GL08" \

pandas/_libs/tslibs/nattype.pyx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -528,6 +528,12 @@ class NaTType(_NaT):
528528
"""
529529
Return a named tuple containing ISO year, week number, and weekday.
530530
531+
See Also
532+
--------
533+
DatetimeIndex.isocalendar : Return a 3-tuple containing ISO year,
534+
week number, and weekday for the given DatetimeIndex object.
535+
datetime.date.isocalendar : The equivalent method for `datetime.date` objects.
536+
531537
Examples
532538
--------
533539
>>> ts = pd.Timestamp('2023-01-01 10:00:00')

pandas/_libs/tslibs/timestamps.pyx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1691,6 +1691,12 @@ class Timestamp(_Timestamp):
16911691
"""
16921692
Return a named tuple containing ISO year, week number, and weekday.
16931693
1694+
See Also
1695+
--------
1696+
DatetimeIndex.isocalendar : Return a 3-tuple containing ISO year,
1697+
week number, and weekday for the given DatetimeIndex object.
1698+
datetime.date.isocalendar : The equivalent method for `datetime.date` objects.
1699+
16941700
Examples
16951701
--------
16961702
>>> ts = pd.Timestamp('2023-01-01 10:00:00')

0 commit comments

Comments
 (0)