More HelpDB pruning for Bit/SparseArray, more examples

Yet MORE examples from the REPL. Fixed and added links,
changd some wording.

Author: kshyatt

base/bitarray.jl

@@ -1005,6 +1005,25 @@ function (~)(B::BitArray)
     return C
 end
 
+"""
+    flipbits!(B::BitArray{N}) -> BitArray{N}
+
+Performs a bitwise not operation on `B`. See [`~`](:ref:`~ operator <~>`).
+
+```jldoctest
+julia> A = bitrand(3,5)
+3×5 BitArray{2}:
+  true   true   true   true   true
+ false  false  false   true  false
+  true  false  false  false   true
+
+julia> flipbits!(A)
+3×5 BitArray{2}:
+ false  false  false  false  false
+  true   true   true  false   true
+ false   true   true   true  false
+```
+"""
 function flipbits!(B::BitArray)
     Bc = B.chunks
     @inbounds if !isempty(Bc)
@@ -1416,6 +1435,39 @@ end
 
 (>>)(B::BitVector, i::Int) = B >>> i
 
+"""
+    rol!(dest::BitVector, src::BitVector, i::Integer) -> BitVector
+
+Performs a left rotation operation on `src` and put the result into `dest`.
+
+```jldoctest
+julia> a = bitrand(5)
+5-element BitArray{1}:
+ false
+ false
+  true
+  true
+  true
+
+julia> b = falses(5);
+
+julia> rol!(b,a,2)
+5-element BitArray{1}:
+  true
+  true
+  true
+ false
+ false
+
+julia> rol!(b,a,3)
+5-element BitArray{1}:
+  true
+  true
+ false
+ false
+  true
+```
+"""
 function rol!(dest::BitVector, src::BitVector, i::Integer)
     length(dest) == length(src) || throw(ArgumentError("destination and source should be of same size"))
     n = length(dest)
@@ -1428,14 +1480,67 @@ function rol!(dest::BitVector, src::BitVector, i::Integer)
     return dest
 end
 
+"""
+    rol!(B::BitVector, i::Integer) -> BitVector
+
+Performs a left rotation operation on `B`.
+
+```jldoctest
+julia> a = bitrand(5)
+5-element BitArray{1}:
+  true
+ false
+ false
+  true
+  true
+
+julia> rol!(a,4)
+5-element BitArray{1}:
+  true
+  true
+ false
+ false
+  true
+"""
 function rol!(B::BitVector, i::Integer)
     return rol!(B, B, i)
 end
 
+"""
+    rol(B::BitVector, i::Integer) -> BitVector
+
+Performs a left rotation operation without modifying `B`.
+See also [`rol!`](:func:`rol!`).
+"""
 function rol(B::BitVector, i::Integer)
     return rol!(similar(B), B, i)
 end
 
+"""
+    ror!(dest::BitVector, src::BitVector, i::Integer) -> BitVector
+
+Performs a right rotation operation on `src` and put the result into `dest`.
+
+```jldoctest
+julia> a = bitrand(5)
+5-element BitArray{1}:
+ false
+ false
+  true
+  true
+  true
+
+julia> b = falses(5);
+
+julia> ror!(b,a,2)
+5-element BitArray{1}:
+  true
+  true
+ false
+ false
+  true
+```
+"""
 function ror!(dest::BitVector, src::BitVector, i::Integer)
     length(dest) == length(src) || throw(ArgumentError("destination and source should be of same size"))
     n = length(dest)
@@ -1448,10 +1553,39 @@ function ror!(dest::BitVector, src::BitVector, i::Integer)
     return dest
 end
 
+"""
+    ror!(B::BitVector, i::Integer) -> BitVector
+
+Performs a right rotation operation on `B`.
+
+```jldoctest
+julia> a = bitrand(5)
+5-element BitArray{1}:
+ false
+  true
+ false
+  true
+ false
+
+julia> ror!(a,3)
+5-element BitArray{1}:
+ false
+  true
+ false
+ false
+  true
+```
+"""
 function ror!(B::BitVector, i::Integer)
     return ror!(B, B, i)
 end
 
+"""
+    ror(B::BitVector, i::Integer) -> BitVector
+
+Performs a right rotation operation without modifying `B`.
+See also [`ror!`](:func:`ror!`).
+"""
 function ror(B::BitVector, i::Integer)
     return ror!(similar(B), B, i)
 end

base/docs/helpdb/Base.jl

@@ -400,20 +400,6 @@ Element-wise multiplication operator.
 """
 Base.:(.*)
 
-"""
-    ror!(dest::BitArray{1}, src::BitArray{1}, i::Integer) -> BitArray{1}
-
-Performs a right rotation operation on `src` and put the result into `dest`.
-"""
-ror!(dest::BitArray{1}, src::BitArray{1}, i::Integer)
-
-"""
-    ror!(B::BitArray{1}, i::Integer) -> BitArray{1}
-
-Performs a right rotation operation on `B`.
-"""
-ror!(B::BitArray{1}, i::Integer)
-
 """
     range(start, [step], length)
 
@@ -805,13 +791,6 @@ Returns `true` if `path` has the sticky bit set, `false` otherwise.
 """
 issticky
 
-"""
-    rol(B::BitArray{1}, i::Integer) -> BitArray{1}
-
-Performs a left rotation operation.
-"""
-rol
-
 """
     Mmap.mmap(io::Union{IOStream,AbstractString,Mmap.AnonymousMmap}[, type::Type{Array{T,N}}, dims, offset]; grow::Bool=true, shared::Bool=true)
            Mmap.mmap(type::Type{Array{T,N}}, dims)
@@ -4330,13 +4309,6 @@ Returns `string` with the first character converted to lowercase.
 """
 lcfirst
 
-"""
-    flipbits!(B::BitArray{N}) -> BitArray{N}
-
-Performs a bitwise not operation on `B`. See [`~`](:ref:`~ operator <~>`).
-"""
-flipbits!
-
 """
     readlink(path) -> AbstractString
 
@@ -7465,20 +7437,6 @@ dims)` will return an array filled with the result of evaluating `Foo()` once.
 """
 fill
 
-"""
-    rol!(dest::BitArray{1}, src::BitArray{1}, i::Integer) -> BitArray{1}
-
-Performs a left rotation operation on `src` and put the result into `dest`.
-"""
-rol!(::BitArray,::BitArray,::Integer)
-
-"""
-    rol!(B::BitArray{1}, i::Integer) -> BitArray{1}
-
-Performs a left rotation operation on `B`.
-"""
-rol!(::BitArray,::Integer)
-
 """
     issubset(a, b)
     ⊆(a,b) -> Bool
@@ -8280,13 +8238,6 @@ Optional argument `msg` is a descriptive error string.
 """
 AssertionError
 
-"""
-    ror(B::BitArray{1}, i::Integer) -> BitArray{1}
-
-Performs a right rotation operation.
-"""
-ror
-
 """
     Ac_ldiv_Bc(A, B)