Skip to content

Commit 288f47a

Browse files
DOC: fix SA01, ES01 for pandas.Timestamp.tz (#59097)
* DOC: fix SA01, ES01 for pandas.Timestamp.tz * DOC: fix SA01, ES01 for pandas.Timestamp.tz
1 parent 46916db commit 288f47a

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
260260
-i "pandas.Timestamp.to_period PR01,SA01" \
261261
-i "pandas.Timestamp.today SA01" \
262262
-i "pandas.Timestamp.toordinal SA01" \
263-
-i "pandas.Timestamp.tz SA01" \
264263
-i "pandas.Timestamp.tz_localize SA01" \
265264
-i "pandas.Timestamp.tzinfo GL08" \
266265
-i "pandas.Timestamp.tzname SA01" \

pandas/_libs/tslibs/timestamps.pyx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2368,6 +2368,17 @@ timedelta}, default 'raise'
23682368
"""
23692369
Alias for tzinfo.
23702370
2371+
The `tz` property provides a simple and direct way to retrieve the timezone
2372+
information of a `Timestamp` object. It is particularly useful when working
2373+
with time series data that includes timezone information, allowing for easy
2374+
access and manipulation of the timezone context.
2375+
2376+
See Also
2377+
--------
2378+
Timestamp.tzinfo : Returns the timezone information of the Timestamp.
2379+
Timestamp.tz_convert : Convert timezone-aware Timestamp to another time zone.
2380+
Timestamp.tz_localize : Localize the Timestamp to a timezone.
2381+
23712382
Examples
23722383
--------
23732384
>>> ts = pd.Timestamp(1584226800, unit='s', tz='Europe/Stockholm')

0 commit comments

Comments
 (0)