Improve docstrings for vec and reshape #27027
Merged
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
Document mutability behavior, add examples with ranges and fix a few issues.
nalimilan
added
docs
mbauman
approved these changes
May 7, 2018
|
CC @StephenVavasis — I should have looked at the docstring myself in #27001! Would you mind reviewing the new wordings and verify that this would have helped your understanding there? |
|
Looks good to me-- thanks for fixing this. |
waldyrious
reviewed
May 7, 2018
base/abstractarraymath.jl
Outdated
| Reshape the array `a` as a one-dimensional column vector. Return `a` if it is | ||
| already an `AbstractVector`. The resulting array | ||
| shares the same underlying data as `a`, so it will only be mutable if `a` is | ||
| mutable, and in that case modifying one will also modify the other. |
There was a problem hiding this comment.
Perhaps "and in that case" --> "in which case"?
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.
Document mutability behavior, add examples with ranges and fix a few issues.
Cc @mbauman (about #26775 (comment)).