8000 Merge pull request #16197 from timhoffm/doc-stack · numpy/numpy@50ce0fc · GitHub
[go: up one dir, main page]
Skip to content < 8000 /span>

Commit 50ce0fc

Browse files
sebergseberg
authored
Merge pull request #16197 from timhoffm/doc-stack
DOC: Unify cross-references between array joining methods
2 parents bb63a1a + a1800a7 commit 50ce0fc

File tree

5 files changed

+35
-29
lines changed

5 files changed

+35
-29
lines changed

‎doc/source/reference/routines.array-manipulation.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,11 @@ Joining arrays
6969

7070
concatenate
7171
stack
72-
column_stack
73-
dstack
74-
hstack
75-
vstack
7672
block
73+
vstack
74+
hstack
75+
dstack
76+
column_stack
7777

7878
Splitting arrays
7979
================

‎doc/source/reference/routines.ma.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,13 +145,13 @@ Joining arrays
145145
.. autosummary::
146146
:toctree: generated/
147147

148+
ma.concatenate
148149
ma.stack
150+
ma.vstack
151+
ma.hstack
152+
ma.dstack
149153
ma.column_stack
150-
ma.concatenate
151154
ma.append
152-
ma.dstack
153-
ma.hstack
154-
ma.vstack
155155

156156

157157
_____

‎numpy/core/multiarray.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -171,14 +171,15 @@ def concatenate(arrays, axis=None, out=None):
171171
array_split : Split an array into multiple sub-arrays of equal or
172172
near-equal size.
173173
split : Split array into a list of multiple sub-arrays of equal size.
174-
hsplit : Split array into multiple sub-arrays horizontally (column wise)
175-
vsplit : Split array into multiple sub-arrays vertically (row wise)
174+
hsplit : Split array into multiple sub-arrays horizontally (column wise).
175+
vsplit : Split array into multiple sub-arrays vertically (row wise).
176176
dsplit : Split array into multiple sub-arrays along the 3rd axis (depth).
177177
stack : Stack a sequence of arrays along a new axis.
178-
hstack : Stack arrays in sequence horizontally (column wise)
179-
vstack : Stack arrays in sequence vertically (row wise)
180-
dstack : Stack arrays in sequence depth wise (along third dimension)
181178
block : Assemble arrays from blocks.
179+
hstack : Stack arrays in sequence horizontally (column wise).
180+
vstack : Stack arrays in sequence vertically (row wise).
181+
dstack : Stack arrays in sequence depth wise (along third dimension).
182+
column_stack : Stack 1-D arrays as columns into a 2-D array.
182183
183184
Notes
184185
-----

‎numpy/core/shape_base.py

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -247,12 +247,13 @@ def vstack(tup):
247247
248248
See Also
249249
--------
250+
concatenate : Join a sequence of arrays along an existing axis.
250251
stack : Join a sequence of arrays along a new axis.
252+
block : Assemble an nd-array from nested lists of blocks.
251253
hstack : Stack arrays in sequence horizontally (column wise).
252-
dstack : Stack arrays in sequence depth wise (along third dimension).
253-
concatenate : Join a sequence of arrays along an existing axis.
254-
vsplit : Split array into a list of multiple sub-arrays vertically.
255-
block : Assemble arrays from blocks.
254+
dstack : Stack arrays in sequence depth wise (along third axis).
255+
column_stack : Stack 1-D arrays as columns into a 2-D array.
256+
vsplit : Split an array into multiple sub-arrays vertically (row-wise).
256257
257258
Examples
258259
--------
@@ -309,12 +310,13 @@ def hstack(tup):
309310
310311
See Also
311312
--------
313+
concatenate : Join a sequence of arrays along an existing axis.
312314
stack : Join a sequence of arrays along a new axis.
315+
block : Assemble an nd-array from nested lists of blocks.
313316
vstack : Stack arrays in sequence vertically (row wise).
314317
dstack : Stack arrays in sequence depth wise (along third axis).
315-
concatenate : Join a sequence of arrays along an existing axis.
316-
hsplit : Split array along second axis.
317-
block : Assemble arrays from blocks.
318+
column_stack : Stack 1-D arrays as columns into a 2-D array.
319+
hsplit : Split an array into multiple sub-arrays horizontally (column-wise).
318320
319321
Examples
320322
--------
@@ -385,8 +387,8 @@ def stack(arrays, axis=0, out=None):
385387
See Also
386388
--------
387389
concatenate : Join a sequence of arrays along an existing axis.
390+
block : Assemble an nd-array from nested lists of blocks.
388391
split : Split array into a list of multiple sub-arrays of equal size.
389-
block : Assemble arrays from blocks.
390392
391393
Examples
392394
--------
@@ -723,12 +725,13 @@ def block(arrays):
723725
724726
See Also
725727
--------
726-
concatenate : Join a sequence of arrays together.
727-
stack : Stack arrays in sequence along a new dimension.
728-
hstack : Stack arrays in sequence horizontally (column wise).
728+
concatenate : Join a sequence of arrays along an existing axis.
729+
stack : Join a sequence of arrays along a new axis.
729730
vstack : Stack arrays in sequence vertically (row wise).
730-
dstack : Stack arrays in sequence depth wise (along third dimension).
731-
vsplit : Split array into a list of multiple sub-arrays vertically.
731+
hstack : Stack arrays in sequence horizontally (column wise).
732+
dstack : Stack arrays in sequence depth wise (along third axis).
733+
column_stack : Stack 1-D arrays as columns into a 2-D array.
734+
vsplit : Split an array into multiple sub-arrays vertically (row-wise).
732735
733736
Notes
734737
-----

‎numpy/lib/shape_base.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -688,10 +688,12 @@ def dstack(tup):
688688
689689
See Also
690690
--------
691-
stack : Join a sequence of arrays along a new axis.
692-
vstack : Stack along first axis.
693-
hstack : Stack along second axis.
694691
concatenate : Join a sequence of arrays along an existing axis.
692+
stack : Join a sequence of arrays along a new axis.
693+
block : Assemble an nd-array from nested lists of blocks.
694+
vstack : Stack arrays in sequence vertically (row wise).
695+
hstack : Stack arrays in sequence horizontally (column wise).
696+
column_stack : Stack 1-D arrays as columns into a 2-D array.
695697
dsplit : Split array along third axis.
696698
697699
Examples

0 commit comments

Comments
 (0)
0