Skip to content

Commit f0bdc17

Browse files
committed
Fixed spelling issues and added 15 new words to known list
1 parent 0e058a0 commit f0bdc17

File tree

8 files changed

+33
-13
lines changed

8 files changed

+33
-13
lines changed

doc/known_words.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,18 @@ th
3030
prepend
3131
eps
3232
whitespace
33+
Mersenne
34+
Zipf
35+
Weibull
36+
Mises
37+
Von
38+
Lomax
39+
multinomial
40+
Hypergeometric
41+
Polyutils
42+
Unary
43+
docstring
44+
Extrema
45+
Penrose
46+
Decompositions
47+
broadcastable

dpnp/dparray.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1064,7 +1064,7 @@ cdef class dparray:
10641064
Limitations
10651065
-----------
10661066
Input array is supported as :obj:`dpnp.ndarray`.
1067-
Input kth is supported as :obj:`int`.
1067+
Input `kth` is supported as :obj:`int`.
10681068
Parameters `axis`, `kind` and `order` are supported only with default values.
10691069

10701070
"""

dpnp/dpnp_array.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -979,12 +979,13 @@ def partition(self, kth, axis=-1, kind="introselect", order=None):
979979
"""
980980
Return a partitioned copy of an array.
981981
982-
Rearranges the elements in the array in such a way that the value of the
983-
element in kth position is in the position it would be in a sorted array.
982+
Rearranges the elements in the array in such a way that the value of
983+
the element in `kth` position is in the position it would be in
984+
a sorted array.
984985
985-
All elements smaller than the kth element are moved before this element and
986-
all equal or greater are moved behind it. The ordering of the elements in
987-
the two partitions is undefined.
986+
All elements smaller than the `kth` element are moved before this
987+
element and all equal or greater are moved behind it. The ordering
988+
of the elements in the two partitions is undefined.
988989
989990
Refer to `dpnp.partition` for full documentation.
990991

dpnp/dpnp_iface_arraycreation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3385,7 +3385,7 @@ def vander(
33853385
tuples of lists, and ndarrays.
33863386
N : int, optional
33873387
Number of columns in the output. If `N` is not specified, a square
3388-
array is returned (N = len(x)).
3388+
array is returned ``(N = len(x))``.
33893389
increasing : bool, optional
33903390
Order of the powers of the columns. If ``True,`` the powers increase
33913391
from left to right, if ``False`` (the default) they are reversed.

dpnp/dpnp_iface_indexing.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -930,7 +930,8 @@ def take_along_axis(a, indices, axis):
930930
>>> import dpnp as np
931931
>>> a = np.array([[10, 30, 20], [60, 40, 50]])
932932
933-
We can sort either by using sort directly, or argsort and this function
933+
We can sort either by using :obj:`dpnp.sort` directly, or
934+
:obj:`dpnp.argsort` and this function:
934935
935936
>>> np.sort(a, axis=1)
936937
array([[10, 20, 30],
@@ -958,7 +959,7 @@ def take_along_axis(a, indices, axis):
958959
[60]])
959960
960961
If we want to get the max and min at the same time, we can stack the
961-
indices first
962+
indices first:
962963
963964
>>> ai_min = np.argmin(a, axis=1, keepdims=True)
964965
>>> ai_max = np.argmax(a, axis=1, keepdims=True)

dpnp/dpnp_iface_linearalgebra.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,10 @@ def inner(a, b):
305305

306306
def kron(a, b):
307307
"""
308-
Returns the kronecker product of two arrays.
308+
Kronecker product of two arrays.
309+
310+
Computes the Kronecker product, a composite array made of blocks of the
311+
second array scaled by the first.
309312
310313
For full documentation refer to :obj:`numpy.kron`.
311314
@@ -597,7 +600,7 @@ def tensordot(a, b, axes=2):
597600
Returns
598601
-------
599602
out : dpnp.ndarray
600-
Returns the tensordot product of `a` and `b`.
603+
Returns the tensor dot product of `a` and `b`.
601604
602605
See Also
603606
--------

dpnp/dpnp_iface_sorting.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ def partition(x1, kth, axis=-1, kind="introselect", order=None):
162162
Limitations
163163
-----------
164164
Input array is supported as :obj:`dpnp.ndarray`.
165-
Input kth is supported as :obj:`int`.
165+
Input `kth` is supported as :obj:`int`.
166166
Parameters `axis`, `kind` and `order` are supported only with default
167167
values.
168168

dpnp/random/dpnp_iface_random.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1626,7 +1626,7 @@ def standard_normal(size=None, device=None, usm_type="device", sycl_queue=None):
16261626
def standard_t(df, size=None):
16271627
"""
16281628
Draw samples from a standard Student’s t distribution with
1629-
df degrees of freedom.
1629+
`df` degrees of freedom.
16301630
16311631
For full documentation refer to :obj:`numpy.random.standard_t`.
16321632

0 commit comments

Comments
 (0)