Skip to content

Commit 8bca186

Browse files
DOC: add SA01 for pandas.Timestamp.now (#59159)
1 parent db13fb5 commit 8bca186

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
244244
-i "pandas.Timestamp.month_name SA01" \
245245
-i "pandas.Timestamp.nanosecond GL08" \
246246
-i "pandas.Timestamp.normalize SA01" \
247-
-i "pandas.Timestamp.now SA01" \
248247
-i "pandas.Timestamp.quarter SA01" \
249248
-i "pandas.Timestamp.replace PR07,SA01" \
250249
-i "pandas.Timestamp.resolution PR02" \

pandas/_libs/tslibs/nattype.pyx

+10
Original file line numberDiff line numberDiff line change
@@ -957,11 +957,21 @@ class NaTType(_NaT):
957957
"""
958958
Return new Timestamp object representing current time local to tz.
959959
960+
This method returns a new `Timestamp` object that represents the current time.
961+
If a timezone is provided, the current time will be localized to that timezone.
962+
Otherwise, it returns the current local time.
963+
960964
Parameters
961965
----------
962966
tz : str or timezone object, default None
963967
Timezone to localize to.
964968
969+
See Also
970+
--------
971+
to_datetime : Convert argument to datetime.
972+
Timestamp.utcnow : Return a new Timestamp representing UTC day and time.
973+
Timestamp.today : Return the current time in the local timezone.
974+
965975
Examples
966976
--------
967977
>>> pd.Timestamp.now() # doctest: +SKIP

pandas/_libs/tslibs/timestamps.pyx

+10
Original file line numberDiff line numberDiff line change
@@ -1465,11 +1465,21 @@ class Timestamp(_Timestamp):
14651465
"""
14661466
Return new Timestamp object representing current time local to tz.
14671467
1468+
This method returns a new `Timestamp` object that represents the current time.
1469+
If a timezone is provided, the current time will be localized to that timezone.
1470+
Otherwise, it returns the current local time.
1471+
14681472
Parameters
14691473
----------
14701474
tz : str or timezone object, default None
14711475
Timezone to localize to.
14721476
1477+
See Also
1478+
--------
1479+
to_datetime : Convert argument to datetime.
1480+
Timestamp.utcnow : Return a new Timestamp representing UTC day and time.
1481+
Timestamp.today : Return the current time in the local timezone.
1482+
14731483
Examples
14741484
--------
14751485
>>> pd.Timestamp.now() # doctest: +SKIP

0 commit comments

Comments
 (0)