Skip to content

Commit 62e95db

Browse files
DOC: Add SA01 ES01 for pandas.Timestamp.dst (#58752)
* DOC: add SA01 ES01 for pandas.Timestamp.dst * DOC: remove SA01 ES01 for pandas.Timestamp.dst * DOC: add SA01 ES01 for pandas.Timestamp.dst
1 parent 068c079 commit 62e95db

File tree

3 files changed

+16
-1
lines changed

3 files changed

+16
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
253253
-i "pandas.Timestamp.ctime SA01" \
254254
-i "pandas.Timestamp.date SA01" \
255255
-i "pandas.Timestamp.day GL08" \
256-
-i "pandas.Timestamp.dst SA01" \
257256
-i "pandas.Timestamp.floor SA01" \
258257
-i "pandas.Timestamp.fold GL08" \
259258
-i "pandas.Timestamp.fromordinal SA01" \

pandas/_libs/tslibs/nattype.pyx

+8
Original file line numberDiff line numberDiff line change
@@ -542,6 +542,14 @@ class NaTType(_NaT):
542542
"""
543543
Return the daylight saving time (DST) adjustment.
544544
545+
This method returns the DST adjustment as a `datetime.timedelta` object
546+
if the Timestamp is timezone-aware and DST is applicable.
547+
548+
See Also
549+
--------
550+
Timestamp.tz_localize : Localize the Timestamp to a timezone.
551+
Timestamp.tz_convert : Convert timezone-aware Timestamp to another time zone.
552+
545553
Examples
546554
--------
547555
>>> ts = pd.Timestamp('2000-06-01 00:00:00', tz='Europe/Brussels')

pandas/_libs/tslibs/timestamps.pyx

+8
Original file line numberDiff line numberDiff line change
@@ -1669,6 +1669,14 @@ class Timestamp(_Timestamp):
16691669
"""
16701670
Return the daylight saving time (DST) adjustment.
16711671
1672+
This method returns the DST adjustment as a `datetime.timedelta` object
1673+
if the Timestamp is timezone-aware and DST is applicable.
1674+
1675+
See Also
1676+
--------
1677+
Timestamp.tz_localize : Localize the Timestamp to a timezone.
1678+
Timestamp.tz_convert : Convert timezone-aware Timestamp to another time zone.
1679+
16721680
Examples
16731681
--------
16741682
>>> ts = pd.Timestamp('2000-06-01 00:00:00', tz='Europe/Brussels')

0 commit comments

Comments
 (0)