Skip to content

Commit f971ac5

Browse files
committed
update fftfreq and rfftfreq docstring
1 parent aeaa633 commit f971ac5

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

dpnp/dpnp_array.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -737,8 +737,9 @@ def copy(self, order="C", device=None, usm_type=None, sycl_queue=None):
737737
738738
Notes
739739
-----
740-
This function is the preferred method for creating an array copy. The
741-
function :func:`dpnp.copy` is similar, but it defaults to using order 'K'.
740+
This function is the preferred method for creating an array copy.
741+
The function :func:`dpnp.copy` is similar, but it defaults to using
742+
order ``"K"``.
742743
743744
Examples
744745
--------

dpnp/dpnp_iface_arraycreation.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -787,7 +787,8 @@ def copy(
787787
includes scalars, lists, lists of tuples, tuples, tuples of tuples,
788788
tuples of lists, and ndarrays.
789789
order : {"C", "F", "A", "K"}, optional
790-
Memory layout of the newly output array. Default: "K".
790+
Memory layout of the newly output array.
791+
Default: ``"K"``.
791792
device : {None, string, SyclDevice, SyclQueue}, optional
792793
An array API concept of device where the output array is created.
793794
The `device` can be ``None`` (the default), an OneAPI filter selector

dpnp/fft/dpnp_iface_fft.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,10 @@ def fftfreq(n, d=1.0, device=None, usm_type=None, sycl_queue=None):
224224
The type of SYCL USM allocation for the output array.
225225
Default: ``None``.
226226
sycl_queue : {None, SyclQueue}, optional
227-
A SYCL queue to use for output array allocation and copying.
227+
A SYCL queue to use for output array allocation and copying. The
228+
`sycl_queue` can be passed as ``None`` (the default), which means
229+
to get the SYCL queue from `device` keyword if present or to use
230+
a default queue.
228231
Default: ``None``.
229232
230233
Returns
@@ -1148,7 +1151,10 @@ def rfftfreq(n, d=1.0, device=None, usm_type=None, sycl_queue=None):
11481151
The type of SYCL USM allocation for the output array.
11491152
Default: ``None``.
11501153
sycl_queue : {None, SyclQueue}, optional
1151-
A SYCL queue to use for output array allocation and copying.
1154+
A SYCL queue to use for output array allocation and copying. The
1155+
`sycl_queue` can be passed as ``None`` (the default), which means
1156+
to get the SYCL queue from `device` keyword if present or to use
1157+
a default queue.
11521158
Default: ``None``.
11531159
11541160
Returns

0 commit comments

Comments
 (0)