[ci skip] fix docstring wording

JuliaLang · Aug 6, 2016 · 6ffe1ab · 6ffe1ab
1 parent fdef48d
commit 6ffe1ab
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 15 deletions.
diff --git a/base/bitarray.jl b/base/bitarray.jl
@@ -1437,7 +1437,7 @@ end
     rol!(dest::BitVector, src::BitVector, i::Integer) -> BitVector
 
 Performs a left rotation operation on `src` and puts the result into `dest`.
-`i` controls how far to rotate each bit.
+`i` controls how far to rotate the bits.
 """
 function rol!(dest::BitVector, src::BitVector, i::Integer)
     length(dest) == length(src) || throw(ArgumentError("destination and source should be of same size"))
@@ -1455,7 +1455,7 @@ end
     rol!(B::BitVector, i::Integer) -> BitVector
 
 Performs a left rotation operation in-place on `B`.
-`i` controls how far to rotate each bit.
+`i` controls how far to rotate the bits.
 """
 function rol!(B::BitVector, i::Integer)
     return rol!(B, B, i)
@@ -1465,7 +1465,7 @@ end
     rol(B::BitVector, i::Integer) -> BitVector
 
 Performs a left rotation operation, returning a new `BitVector`.
-`i` controls how far to rotate each bit.
+`i` controls how far to rotate the bits.
 See also [`rol!`](:func:`rol!`).
 
 ```jldoctest
@@ -1510,7 +1510,7 @@ end
     ror!(dest::BitVector, src::BitVector, i::Integer) -> BitVector
 
 Performs a right rotation operation on `src` and puts the result into `dest`.
-`i` controls how far to rotate each bit.
+`i` controls how far to rotate the bits.
 """
 function ror!(dest::BitVector, src::BitVector, i::Integer)
     length(dest) == length(src) || throw(ArgumentError("destination and source should be of same size"))
@@ -1528,7 +1528,7 @@ end
     ror!(B::BitVector, i::Integer) -> BitVector
 
 Performs a right rotation operation in-place on `B`.
-`i` controls how far to rotate each bit.
+`i` controls how far to rotate the bits.
 """
 function ror!(B::BitVector, i::Integer)
     return ror!(B, B, i)
@@ -1538,7 +1538,7 @@ end
     ror(B::BitVector, i::Integer) -> BitVector
 
 Performs a right rotation operation on `B`, returning a new `BitVector`.
-`i` controls how far to rotate each bit.
+`i` controls how far to rotate the bits.
 See also [`ror!`](:func:`ror!`).
 
 ```jldoctest

diff --git a/base/sparse/sparsematrix.jl b/base/sparse/sparsematrix.jl
@@ -1258,7 +1258,7 @@ speye(m::Integer, n::Integer) = speye(Float64, m, n)
 """
     speye(S)
 
-Create a sparse identity matrix with the same size as that of `S`.
+Create a sparse identity matrix with the same size as `S`.
 
 ```jldoctest
 julia> A = sparse([1,2,3,4],[2,4,3,1],[5.,4.,3.,2.])

diff --git a/doc/stdlib/arrays.rst b/doc/stdlib/arrays.rst
@@ -1230,19 +1230,19 @@ to/from the latter via ``Array(bitarray)`` and ``BitArray(array)``, respectively
 
    .. Docstring generated from Julia source
 
-   Performs a left rotation operation on ``src`` and puts the result into ``dest``\ . ``i`` controls how far to rotate each bit.
+   Performs a left rotation operation on ``src`` and puts the result into ``dest``\ . ``i`` controls how far to rotate the bits.
 
 .. function:: rol!(B::BitVector, i::Integer) -> BitVector
 
    .. Docstring generated from Julia source
 
-   Performs a left rotation operation in-place on ``B``\ . ``i`` controls how far to rotate each bit.
+   Performs a left rotation operation in-place on ``B``\ . ``i`` controls how far to rotate the bits.
 
 .. function:: rol(B::BitVector, i::Integer) -> BitVector
 
    .. Docstring generated from Julia source
 
-   Performs a left rotation operation, returning a new ``BitVector``\ . ``i`` controls how far to rotate each bit. See also :func:`rol!`\ .
+   Performs a left rotation operation, returning a new ``BitVector``\ . ``i`` controls how far to rotate the bits. See also :func:`rol!`\ .
 
    .. doctest::
 
@@ -1282,19 +1282,19 @@ to/from the latter via ``Array(bitarray)`` and ``BitArray(array)``, respectively
 
    .. Docstring generated from Julia source
 
-   Performs a right rotation operation on ``src`` and puts the result into ``dest``\ . ``i`` controls how far to rotate each bit.
+   Performs a right rotation operation on ``src`` and puts the result into ``dest``\ . ``i`` controls how far to rotate the bits.
 
 .. function:: ror!(B::BitVector, i::Integer) -> BitVector
 
    .. Docstring generated from Julia source
 
-   Performs a right rotation operation in-place on ``B``\ . ``i`` controls how far to rotate each bit.
+   Performs a right rotation operation in-place on ``B``\ . ``i`` controls how far to rotate the bits.
 
 .. function:: ror(B::BitVector, i::Integer) -> BitVector
 
    .. Docstring generated from Julia source
 
-   Performs a right rotation operation on ``B``\ , returning a new ``BitVector``\ . ``i`` controls how far to rotate each bit. See also :func:`ror!`\ .
+   Performs a right rotation operation on ``B``\ , returning a new ``BitVector``\ . ``i`` controls how far to rotate the bits. See also :func:`ror!`\ .
 
    .. doctest::
 
@@ -1428,7 +1428,7 @@ dense counterparts. The following functions are specific to sparse arrays.
 
    .. Docstring generated from Julia source
 
-   Create a sparse identity matrix with the same size as that of ``S``\ .
+   Create a sparse identity matrix with the same size as ``S``\ .
 
    .. doctest::
 

diff --git a/doc/stdlib/collections.rst b/doc/stdlib/collections.rst
@@ -1364,7 +1364,7 @@ Dequeues
 
        julia> deleteat!([6, 5, 4, 3, 2, 1], (2, 2))
        ERROR: ArgumentError: indices must be unique and sorted
-        in deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:541
+        in deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:575
         ...
 
 .. function:: splice!(collection, index, [replacement]) -> item