DOC: note in h/v/dstack points users to stack/concatenate #7253
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -184,6 +184,10 @@ def vstack(tup): | |||
| Take a sequence of arrays and stack them vertically to make a single | |||
| array. Rebuild arrays divided by `vsplit`. | |||
|
|
|||
| This function continues to be supported for backward compatibility, but | |||
| you should prefer ``np.concatenate`` or ``np.stack`` (keep in mind that | |||
| ``np.stack`` was added in numpy version 1.10). | |||
There was a problem hiding this comment.
How about a simple, unparnthesized,
The ``np.stack`` function was added in NumPy 1.10.
or maybe
or the ``np.stack`` function added in numpy 1.10.
There was a problem hiding this comment.
@charris I like your first suggestion:
This function continues to be supported for backward compatibility, but
you should prefer ``np.concatenate`` or ``np.stack``. The ``np.stack``
function was added in NumPy 1.10.
|
For commits where the changes don't get tested, add |
|
Clever. I didn't see it anywhere in the dev workflow and I wasn't familiar with Travis' customization options. I'll remember it for a next time, thanks. |
charris
added a commit
that referenced
this pull request
Feb 16, 2016
DOC: note in h/v/dstack points users to stack/concatenate
|
Should we be doing the same for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Warns users that they should be using
stackandconcatenaterather than the*stackfunctions. Discussion at #5605 shows why using stack/concatenate should be preferred (in particular this comment).Also see the discussion at #7183, and previous PR #7191.
@shoyer something along these lines is what you had in mind, right? Please let me know if this is the correct location for this message (it could also be placed under Notes), and whether it is sufficiently explicit.