Skip to content

Commit 505f740

Browse files
committed
edits per reviewer request
1 parent 07c9594 commit 505f740

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

pandas/_libs/tslibs/conversion.pyx

+35-1
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,14 @@ cpdef int64_t pydt_to_i8(object pydt) except? -1:
9393
"""
9494
Convert to int64 representation compatible with numpy datetime64; converts
9595
to UTC
96+
97+
Parameters
98+
----------
99+
pydt : object
100+
101+
Returns
102+
-------
103+
i8value : np.int64
96104
"""
97105
cdef:
98106
_TSObject ts
@@ -806,6 +814,11 @@ def date_normalize(ndarray[int64_t] stamps, tz=None):
806814
rounding down to the beginning of the day (i.e. midnight). If `tz`
807815
is not None, then this is midnight for this timezone.
808816
817+
Parameters
818+
----------
819+
stamps : int64 ndarray
820+
tz : tzinfo or None
821+
809822
Returns
810823
-------
811824
result : int64 ndarray of converted of normalized nanosecond timestamps
@@ -838,6 +851,11 @@ cdef ndarray[int64_t] _normalize_local(ndarray[int64_t] stamps, object tz):
838851
rounding down to the beginning of the day (i.e. midnight) for the
839852
given timezone `tz`.
840853
854+
Parameters
855+
----------
856+
stamps : int64 ndarray
857+
tz : tzinfo or None
858+
841859
Returns
842860
-------
843861
result : int64 ndarray of converted of normalized nanosecond timestamps
@@ -897,6 +915,17 @@ cdef ndarray[int64_t] _normalize_local(ndarray[int64_t] stamps, object tz):
897915

898916

899917
cdef inline int64_t _normalized_stamp(pandas_datetimestruct *dts) nogil:
918+
"""
919+
Normalize the given datetimestruct to midnight, then convert to int64_t.
920+
921+
Parameters
922+
----------
923+
*dts : pointer to pandas_datetimestruct
924+
925+
Returns
926+
-------
927+
stamp : int64
928+
"""
900929
dts.hour = 0
901930
dts.min = 0
902931
dts.sec = 0
@@ -911,9 +940,14 @@ def is_date_array_normalized(ndarray[int64_t] stamps, tz=None):
911940
midnight, i.e. hour == minute == second == 0. If the optional timezone
912941
`tz` is not None, then this is midnight for this timezone.
913942
943+
Parameters
944+
----------
945+
stamps : int64 ndarray
946+
tz : tzinfo or None
947+
914948
Returns
915949
-------
916-
is_normalizaed : bool True if all stamps are normalized
950+
is_normalized : bool True if all stamps are normalized
917951
"""
918952
cdef:
919953
Py_ssize_t i, n = len(stamps)

0 commit comments

Comments
 (0)