Skip to content

Commit 7e788f7

Browse files
committed
Aligned dpnp.ndarray docs
1 parent 8ad627f commit 7e788f7

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

dpnp/dpnp_array.py

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ def astype(self, dtype, order="K", casting="unsafe", subok=True, copy=True):
533533
"""
534534
Copy the array with data type casting.
535535
536-
For full documentation refer to :obj:`numpy.ndarray.astype`.
536+
Refer to :obj:`dpnp.astype` for full documentation.
537537
538538
Parameters
539539
----------
@@ -593,7 +593,12 @@ def astype(self, dtype, order="K", casting="unsafe", subok=True, copy=True):
593593
# 'byteswap',
594594

595595
def choose(input, choices, out=None, mode="raise"):
596-
"""Construct an array from an index array and a set of arrays to choose from."""
596+
"""
597+
Construct an array from an index array and a set of arrays to choose from.
598+
599+
Refer to :obj:`dpnp.choose` for full documentation.
600+
601+
"""
597602

598603
return dpnp.choose(input, choices, out, mode)
599604

@@ -613,7 +618,7 @@ def conj(self):
613618
"""
614619
Complex-conjugate all elements.
615620
616-
For full documentation refer to :obj:`numpy.ndarray.conj`.
621+
Refer to :obj:`dpnp.conjugate` for full documentation.
617622
618623
"""
619624

@@ -626,7 +631,7 @@ def conjugate(self):
626631
"""
627632
Return the complex conjugate, element-wise.
628633
629-
For full documentation refer to :obj:`numpy.ndarray.conjugate`.
634+
Refer to :obj:`dpnp.conjugate` for full documentation.
630635
631636
"""
632637

@@ -683,9 +688,7 @@ def cumsum(self, axis=None, dtype=None, out=None):
683688
"""
684689
Return the cumulative sum of the elements along the given axis.
685690
686-
See Also
687-
--------
688-
:obj:`dpnp.cumsum`
691+
Refer to :obj:`dpnp.cumsum` for full documentation.
689692
690693
"""
691694

@@ -697,9 +700,7 @@ def diagonal(input, offset=0, axis1=0, axis2=1):
697700
"""
698701
Return specified diagonals.
699702
700-
See Also
701-
--------
702-
:obj:`dpnp.diagonal`
703+
Refer to :obj:`dpnp.diagonal` for full documentation.
703704
704705
"""
705706

@@ -709,7 +710,7 @@ def dot(self, b, out=None):
709710
"""
710711
Dot product of two arrays.
711712
712-
For full documentation refer to :obj:`dpnp.dot`.
713+
Refer to :obj:`dpnp.dot` for full documentation.
713714
714715
Examples
715716
--------
@@ -1013,7 +1014,7 @@ def prod(
10131014
"""
10141015
Returns the prod along a given axis.
10151016
1016-
For full documentation refer to :obj:`dpnp.prod`.
1017+
Refer to :obj:`dpnp.prod` for full documentation.
10171018
10181019
"""
10191020

@@ -1023,7 +1024,7 @@ def put(self, indices, vals, /, *, axis=None, mode="wrap"):
10231024
"""
10241025
Puts values of an array into another array along a given axis.
10251026
1026-
For full documentation refer to :obj:`numpy.put`.
1027+
Refer to :obj:`dpnp.put` for full documentation.
10271028
10281029
"""
10291030

@@ -1033,7 +1034,7 @@ def ravel(self, order="C"):
10331034
"""
10341035
Return a contiguous flattened array.
10351036
1036-
For full documentation refer to :obj:`dpnp.ravel`.
1037+
Refer to :obj:`dpnp.ravel` for full documentation.
10371038
10381039
"""
10391040

@@ -1083,7 +1084,7 @@ def repeat(self, repeats, axis=None):
10831084
"""
10841085
Repeat elements of an array.
10851086
1086-
For full documentation refer to :obj:`dpnp.repeat`.
1087+
Refer to :obj:`dpnp.repeat` for full documentation.
10871088
10881089
"""
10891090

@@ -1093,7 +1094,7 @@ def reshape(self, *sh, **kwargs):
10931094
"""
10941095
Returns an array containing the same data with a new shape.
10951096
1096-
For full documentation refer to :obj:`numpy.ndarray.reshape`.
1097+
Refer to :obj:`dpnp.reshape` for full documentation.
10971098
10981099
Returns
10991100
-------
@@ -1124,8 +1125,7 @@ def round(self, decimals=0, out=None):
11241125
"""
11251126
Return array with each element rounded to the given number of decimals.
11261127
1127-
.. seealso::
1128-
:obj:`dpnp.around` for full documentation.
1128+
Refer to :obj:`dpnp.round` for full documentation.
11291129
11301130
"""
11311131

@@ -1271,7 +1271,7 @@ def sum(
12711271
"""
12721272
Returns the sum along a given axis.
12731273
1274-
For full documentation refer to :obj:`dpnp.sum`.
1274+
Refer to :obj:`dpnp.sum` for full documentation.
12751275
12761276
"""
12771277

@@ -1289,7 +1289,7 @@ def swapaxes(self, axis1, axis2):
12891289
"""
12901290
Interchange two axes of an array.
12911291
1292-
For full documentation refer to :obj:`numpy.swapaxes`.
1292+
Refer to :obj:`dpnp.swapaxes` for full documentation.
12931293
12941294
"""
12951295

@@ -1299,7 +1299,7 @@ def take(self, indices, /, *, axis=None, out=None, mode="wrap"):
12991299
"""
13001300
Take elements from an array along an axis.
13011301
1302-
For full documentation refer to :obj:`numpy.take`.
1302+
Refer to :obj:`dpnp.take` for full documentation.
13031303
13041304
"""
13051305

0 commit comments

Comments
 (0)