Skip to content

Commit d991cfa

Browse files
committed
Fixed spelling issues and added 10 new words to known list
1 parent f0bdc17 commit d991cfa

8 files changed

+59
-48
lines changed

doc/known_words.txt

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,57 @@
11
backend
22
bitwise
33
boolean
4+
broadcastable
45
broadcasted
6+
byteorder
57
Cholesky
68
conda
9+
Decompositions
710
dimensionality
11+
docstring
812
dpctl
913
dpnp
1014
dtype
1115
dtypes
16+
endian
17+
eps
18+
epsneg
19+
Extrema
20+
finfo
1221
Fortran
22+
Frobenius
23+
Hypergeometric
24+
iinfo
25+
Infs
1326
iterable
27+
Lomax
28+
Mersenne
1429
meshgrid
30+
Mises
31+
multinomial
1532
NaN
33+
NaT
1634
ndarray
1735
ndarrays
1836
oneAPI
37+
Penrose
38+
Polyutils
39+
prepend
1940
representable
2041
runtimes
2142
scikit
43+
signum
44+
subarray
45+
subarrays
46+
subclasses
47+
th
2248
ufunc
2349
ufuncs
50+
Unary
51+
unicode
2452
usm
2553
Vandermonde
26-
signum
27-
Infs
28-
subclasses
29-
th
30-
prepend
31-
eps
54+
Von
55+
Weibull
3256
whitespace
33-
Mersenne
3457
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/dpnp_array.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1192,9 +1192,10 @@ def sort(self, axis=-1, kind=None, order=None):
11921192
11931193
Note
11941194
----
1195-
`axis` in :obj:`dpnp.sort` could be integr or ``None``. If ``None``,
1196-
the array is flattened before sorting. However, `axis` in :obj:`dpnp.ndarray.sort`
1197-
can only be integer since it sorts an array in-place.
1195+
`axis` in :obj:`dpnp.sort` could be integer or ``None``. If ``None``,
1196+
the array is flattened before sorting. However, `axis` in
1197+
:obj:`dpnp.ndarray.sort` can only be integer since it sorts an array
1198+
in-place.
11981199
11991200
Examples
12001201
--------
@@ -1326,11 +1327,12 @@ def transpose(self, *axes):
13261327
----------
13271328
axes : None, tuple or list of ints, n ints, optional
13281329
* ``None`` or no argument: reverses the order of the axes.
1329-
* tuple or list of integers: `i` in the `j`-th place in the
1330+
* ``tuple or list of ints``: `i` in the `j`-th place in the
13301331
tuple/list means that the array’s `i`-th axis becomes the
13311332
transposed array’s `j`-th axis.
1332-
* n ints: same as an n-tuple/n-list of the same ints (this form is
1333-
intended simply as a “convenience” alternative to the tuple form).
1333+
* ``n ints``: same as an n-tuple/n-list of the same integers (this
1334+
form is intended simply as a “convenience” alternative to the
1335+
tuple form).
13341336
13351337
Returns
13361338
-------

dpnp/dpnp_iface_arraycreation.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2117,8 +2117,8 @@ def geomspace(
21172117
The final value of the sequence, in any form that can be converted to
21182118
an array. This includes scalars, lists, lists of tuples, tuples, tuples
21192119
of tuples, tuples of lists, and ndarrays. If `endpoint` is ``False``
2120-
num + 1 values are spaced over the interval in log-space, of which all
2121-
but the last (a sequence of length num) are returned.
2120+
``num + 1`` values are spaced over the interval in log-space, of which
2121+
all but the last (a sequence of length `num`) are returned.
21222122
num : int, optional
21232123
Number of samples to generate. Default is 50.
21242124
dtype : dtype, optional
@@ -2152,12 +2152,12 @@ def geomspace(
21522152
21532153
See Also
21542154
--------
2155-
:obj:`dpnp.logspace` : Similar to geomspace, but with endpoints specified
2156-
using log and base.
2157-
:obj:`dpnp.linspace` : Similar to geomspace, but with arithmetic instead of
2158-
geometric progression.
2159-
:obj:`dpnp.arange` : Similar to linspace, with the step size specified
2160-
instead of the number of samples.
2155+
:obj:`dpnp.logspace` : Similar to :obj:`dpnp.geomspace`, but with endpoints
2156+
specified using log and base.
2157+
:obj:`dpnp.linspace` : Similar to :obj:`dpnp.geomspace`, but with
2158+
arithmetic instead of geometric progression.
2159+
:obj:`dpnp.arange` : Similar to :obj:`dpnp.linspace`, with the step size
2160+
specified instead of the number of samples.
21612161
21622162
Examples
21632163
--------
@@ -2776,7 +2776,7 @@ class MGridClass:
27762776
-------
27772777
out : one dpnp.ndarray or tuple of dpnp.ndarray
27782778
Returns one array of grid indices,
2779-
grid.shape = (len(dimensions),) + tuple(dimensions).
2779+
``grid.shape = (len(dimensions),) + tuple(dimensions)``.
27802780
27812781
Examples
27822782
--------

dpnp/dpnp_iface_indexing.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ def indices(
419419
out : one dpnp.ndarray or tuple of dpnp.ndarray
420420
If sparse is ``False``:
421421
Returns one array of grid indices,
422-
grid.shape = (len(dimensions),) + tuple(dimensions).
422+
``grid.shape = (len(dimensions),) + tuple(dimensions)``.
423423
424424
If sparse is ``True``:
425425
Returns a tuple of arrays,

dpnp/dpnp_iface_linearalgebra.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ def inner(a, b):
243243
See Also
244244
--------
245245
:obj:`dpnp.einsum` : Einstein summation convention..
246-
:obj:`dpnp.dot` : Generalised matrix product,
246+
:obj:`dpnp.dot` : Generalized matrix product,
247247
using second last dimension of `b`.
248248
:obj:`dpnp.tensordot` : Sum products over arbitrary axes.
249249

dpnp/dpnp_iface_manipulation.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -851,7 +851,7 @@ def expand_dims(a, axis):
851851
Hence, if provided `-1`, the resolved axis position is `N` (i.e.,
852852
a singleton dimension must be appended to the input array `a`).
853853
If provided `-N-1`, the resolved axis position is `0` (i.e., a
854-
singleton dimension is prepended to the input array `a`).
854+
singleton dimension is added to the input array `a`).
855855
856856
See Also
857857
--------
@@ -929,8 +929,8 @@ def flip(m, axis=None):
929929
Axis or axes along which to flip over. The default,
930930
``axis=None``, will flip over all of the axes of the input array.
931931
If `axis` is negative it counts from the last to the first axis.
932-
If `axis` is a tuple of ints, flipping is performed on all of the axes
933-
specified in the tuple.
932+
If `axis` is a tuple of integers, flipping is performed on all of
933+
the axes specified in the tuple.
934934
935935
Returns
936936
-------
@@ -1435,11 +1435,10 @@ def roll(x, shift, axis=None):
14351435
a : {dpnp.ndarray, usm_ndarray}
14361436
Input array.
14371437
shift : int or tuple of ints
1438-
The number of places by which elements are shifted. If a tuple,
1439-
then `axis` must be a tuple of the same size, and each of the
1440-
given axes is shifted by the corresponding number. If an int
1441-
while `axis` is a tuple of ints, then the same value is used for
1442-
all given axes.
1438+
The number of places by which elements are shifted. If a tuple, then
1439+
`axis` must be a tuple of the same size, and each of the given axes
1440+
is shifted by the corresponding number. If an integer while `axis` is
1441+
a tuple of integers, then the same value is used for all given axes.
14431442
axis : int or tuple of ints, optional
14441443
Axis or axes along which elements are shifted. By default, the
14451444
array is flattened before shifting, after which the original

dpnp/dpnp_iface_trigonometric.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -847,7 +847,7 @@ def degrees(x1, **kwargs):
847847
--------
848848
:obj:`dpnp.exp` : Calculate exponents for all elements in the array.
849849
:obj:`dpnp.exp2` : Calculate `2**x` for all elements in the array.
850-
:obj:`dpnp.log1p` : Callculate ``log(1 + x)``, the inverse of expm1.
850+
:obj:`dpnp.log1p` : Calculate ``log(1 + x)``, the inverse of :obj:`dpnp.expm1`.
851851
852852
Examples
853853
--------

dpnp/linalg/dpnp_iface_linalg.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ def det(a):
222222
223223
Examples
224224
--------
225-
The determinant of a 2-D array [[a, b], [c, d]] is ad - bc:
225+
The determinant of a 2-D array ``[[a, b], [c, d]]`` is ``ad - bc``:
226226
227227
>>> import dpnp as dp
228228
>>> a = dp.array([[1, 2], [3, 4]])
@@ -1177,7 +1177,7 @@ def slogdet(a):
11771177
11781178
Examples
11791179
--------
1180-
The determinant of a 2-D array [[a, b], [c, d]] is ad - bc:
1180+
The determinant of a 2-D array ``[[a, b], [c, d]]`` is ``ad - bc``:
11811181
11821182
>>> import dpnp as dp
11831183
>>> a = dp.array([[1, 2], [3, 4]])

0 commit comments

Comments
 (0)