Removed default descriptions from multidimensional.jl #23542
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
Removed redundant descriptions along the lines of ```markdown cumsum!(B, A, dim::Integer=1) Cumulative sum of A along a dimension, storing the result in B. **The dimension defaults to 1.** See also cumsum. ```
fredrikekre
reviewed
Sep 1, 2017
base/multidimensional.jl
Outdated
| @@ -797,8 +796,7 @@ end | |||
| """ | |||
| accumulate!(op, B, A, dim=1) | |||
|
|
|||
| Cumulative operation `op` on `A` along a dimension, storing the result in `B`. | |||
| The dimension defaults to 1. See also [`accumulate`](@ref). | |||
| Cumulative operation `op` on `A` along a dimension, storing the result in `B`. See also [`accumulate`](@ref). | |||
There was a problem hiding this comment.
Perhaps add a linebreak before the second sentence? We try to stay within 92 characters per line, see https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#code-formatting-guidelines
|
As far as I can tell the dimensions here still default to 1. They shouldn't but they still do. |
This was referenced Sep 1, 2017
nalimilan
approved these changes
Sep 4, 2017
There was a problem hiding this comment.
Thanks @Shorty66!
@StefanKarpinski I think you misunderstood what this PR does: it just removes information from the description when it's redundant with the signature.
nalimilan
requested changes
Sep 4, 2017
base/multidimensional.jl
Outdated
| @@ -705,15 +704,15 @@ cumprod(A::AbstractArray, axis::Integer=1) = accumulate(*, A, axis) | |||
| """ | |||
| cumprod!(B, A, dim::Integer=1) | |||
|
|
|||
| Cumulative product of `A` along a dimension, storing the result in `B`. The dimension defaults to 1. | |||
| Cumulative product of `A` along a dimension, storing the result in `B`. | |||
There was a problem hiding this comment.
Woops, turns out the CI failures are legitimate and related to the trailing space here.
nalimilan
approved these changes
Sep 4, 2017
|
Fair enough, but we need to remove the argument altogether. |
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.
Removed default descriptions which were redundant with the method signature.
E.g.