Skip to content

Commit 9e22a88

Browse files
committed
fix timestamp Docstring validation err
1 parent a72c94c commit 9e22a88

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

pandas/_libs/tslibs/nattype.pyx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1013,6 +1013,23 @@ class NaTType(_NaT):
10131013
"""
10141014
Return POSIX timestamp as float.
10151015
1016+
This method converts the `Timestamp` object to a POSIX timestamp, which is
1017+
the number of seconds since the Unix epoch (January 1, 1970). The returned
1018+
value is a floating-point number, where the integer part represents the
1019+
seconds, and the fractional part represents the microseconds.
1020+
1021+
Returns
1022+
-------
1023+
float
1024+
The POSIX timestamp representation of the `Timestamp` object.
1025+
1026+
See Also
1027+
--------
1028+
Timestamp.fromtimestamp : Construct a `Timestamp` from a POSIX timestamp.
1029+
datetime.datetime.timestamp : Equivalent method from the `datetime` module.
1030+
Timestamp.to_pydatetime : Convert the `Timestamp` to a `datetime` object.
1031+
Timestamp.to_datetime64 : Converts `Timestamp` to `numpy.datetime64`.
1032+
10161033
Examples
10171034
--------
10181035
>>> ts = pd.Timestamp('2020-03-14T15:32:52.192548')

0 commit comments

Comments
 (0)