Skip to content

Commit cb32c6f

Browse files
Tweaks to docstrings of extract, place, nonzero
1 parent 9b94ea0 commit cb32c6f

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

dpctl/tensor/_indexing_functions.py

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -192,14 +192,14 @@ def extract(condition, arr):
192192
193193
Args:
194194
conditions: usm_ndarray
195-
An array whose non-zero or True entries indicate the element
196-
of `arr` to extract.
195+
An array whose non-zero or True entries indicate the element
196+
of `arr` to extract.
197197
arr: usm_ndarray
198-
Input array of the same size as `condition`.
198+
Input array of the same size as `condition`.
199199
200200
Returns:
201-
extract: usm_ndarray
202-
Rank 1 array of values from `arr` where `condition` is True.
201+
usm_ndarray
202+
Rank 1 array of values from `arr` where `condition` is True.
203203
"""
204204
if not isinstance(condition, dpt.usm_ndarray):
205205
raise TypeError(
@@ -231,16 +231,16 @@ def place(arr, mask, vals):
231231
equivalent to ``arr[condition] = vals``.
232232
233233
Args:
234-
arr: usm_ndarray
235-
Array to put data into.
234+
arr: usm_ndarray
235+
Array to put data into.
236236
mask: usm_ndarray
237-
Boolean mask array. Must have the same size as `arr`.
237+
Boolean mask array. Must have the same size as `arr`.
238238
vals: usm_ndarray
239-
Values to put into `arr`. Only the first N elements are
240-
used, where N is the number of True values in `mask`. If
241-
`vals` is smaller than N, it will be repeated, and if
242-
elements of `arr` are to be masked, this sequence must be
243-
non-empty. Array `vals` must be one dimensional.
239+
Values to put into `arr`. Only the first N elements are
240+
used, where N is the number of True values in `mask`. If
241+
`vals` is smaller than N, it will be repeated, and if
242+
elements of `arr` are to be masked, this sequence must be
243+
non-empty. Array `vals` must be one dimensional.
244244
"""
245245
if not isinstance(arr, dpt.usm_ndarray):
246246
raise TypeError(
@@ -295,11 +295,11 @@ def nonzero(arr):
295295
row-major, C-style order.
296296
297297
Args:
298-
arr: usm_ndarray
299-
Input array, which has non-zero array rank.
298+
arr: usm_ndarray
299+
Input array, which has non-zero array rank.
300300
Returns:
301-
tuple_of_usm_ndarrays: tuple
302-
Indices of non-zero array elements.
301+
Tuple[usm_ndarray]
302+
Indices of non-zero array elements.
303303
"""
304304
if not isinstance(arr, dpt.usm_ndarray):
305305
raise TypeError(

0 commit comments

Comments
 (0)