@@ -84,8 +84,8 @@ cpdef ndarray[int64_t, ndim=1] unique_deltas(const int64_t[:] arr):
84
84
85
85
Returns
86
86
-------
87
- result : ndarray[int64_t]
88
- result is sorted
87
+ ndarray[int64_t]
88
+ An ordered ndarray[int64_t]
89
89
"""
90
90
cdef:
91
91
Py_ssize_t i, n = len (arr)
@@ -150,9 +150,10 @@ def is_lexsorted(list_of_arrays: list) -> bint:
150
150
@ cython.wraparound (False )
151
151
def groupsort_indexer (const int64_t[:] index , Py_ssize_t ngroups ):
152
152
"""
153
- compute a 1-d indexer that is an ordering of the passed index,
154
- ordered by the groups. This is a reverse of the label
155
- factorization process.
153
+ Compute a 1-d indexer.
154
+
155
+ The indexer is an ordering of the passed index,
156
+ ordered by the groups.
156
157
157
158
Parameters
158
159
----------
@@ -161,7 +162,14 @@ def groupsort_indexer(const int64_t[:] index, Py_ssize_t ngroups):
161
162
ngroups: int64
162
163
number of groups
163
164
164
- return a tuple of (1-d indexer ordered by groups, group counts)
165
+ Returns
166
+ -------
167
+ tuple
168
+ 1-d indexer ordered by groups, group counts
169
+
170
+ Notes
171
+ -----
172
+ This is a reverse of the label factorization process.
165
173
"""
166
174
167
175
cdef:
@@ -391,6 +399,7 @@ def _validate_limit(nobs: int, limit=None) -> int:
391
399
Returns
392
400
-------
393
401
int
402
+ The limit.
394
403
"""
395
404
if limit is None:
396
405
lim = nobs
@@ -669,7 +678,8 @@ def is_monotonic(ndarray[algos_t, ndim=1] arr, bint timelike):
669
678
"""
670
679
Returns
671
680
-------
672
- is_monotonic_inc, is_monotonic_dec, is_unique
681
+ tuple
682
+ is_monotonic_inc, is_monotonic_dec, is_unique
673
683
"""
674
684
cdef:
675
685
Py_ssize_t i, n
0 commit comments