Remove docs for deprecated cummin/cummax, more cross refs (#19882)

JuliaLang · Jan 6, 2017 · a861aaf · a861aaf
1 parent 45d2fe0
commit a861aaf
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 19 deletions.
diff --git a/base/docs/helpdb/Base.jl b/base/docs/helpdb/Base.jl
@@ -54,13 +54,6 @@ Calling `Ref(array[, index])` is generally preferable to this function.
 """
 pointer
 
-"""
-    cummin(A, [dim])
-
-Cumulative minimum along a dimension. The dimension defaults to 1.
-"""
-cummin
-
 """
     precision(num::AbstractFloat)
 
@@ -542,13 +535,6 @@ be passed, to be returned from the last `produce` call in the producer.
 """
 consume
 
-"""
-    cummax(A, [dim])
-
-Cumulative maximum along a dimension. The dimension defaults to 1.
-"""
-cummax
-
 """
     isinteractive() -> Bool
 

diff --git a/base/multidimensional.jl b/base/multidimensional.jl
@@ -579,10 +579,10 @@ function cumsum{T}(A::AbstractArray{T}, axis::Integer=1)
 end
 
 """
-    cumsum!(B, A, [dim])
+    cumsum!(B, A, dim::Integer=1)
 
 Cumulative sum of `A` along a dimension, storing the result in `B`. The dimension defaults
-to 1.
+to 1. See also [`cumsum`](@ref).
 """
 cumsum!(B, A, axis::Integer=1) = accumulate!(+, B, A, axis)
 
@@ -613,9 +613,10 @@ julia> cumprod(a,2)
 cumprod(A::AbstractArray, axis::Integer=1) = accumulate(*, A, axis)
 
 """
-    cumprod!(B, A, [dim])
+    cumprod!(B, A, dim::Integer=1)
 
 Cumulative product of `A` along a dimension, storing the result in `B`. The dimension defaults to 1.
+See also [`cumprod`](@ref).
 """
 cumprod!(B, A, axis::Integer=1) = accumulate!(*, B, A, axis)
 

diff --git a/doc/src/stdlib/arrays.md b/doc/src/stdlib/arrays.md
@@ -108,8 +108,6 @@ Base.cumprod!
 Base.cumsum
 Base.cumsum!
 Base.cumsum_kbn
-Base.cummin
-Base.cummax
 Base.LinAlg.diff
 Base.LinAlg.gradient
 Base.rot180