Merge pull request #14254 from danielarndt/documentation-eachindex

Fix invalid documentation about eachindex

Author: tkelman

base/docs/helpdb.jl

@@ -3320,29 +3320,30 @@ Creates an iterable object for visiting each index of an AbstractArray `A` in an
 
 Example for a sparse 2-d array:
 
-    julia> A = sprand(2, 3, 0.5)
-    2x3 sparse matrix with 4 Float64 entries:
-        [1, 1]  =  0.598888
-        [1, 2]  =  0.0230247
-        [1, 3]  =  0.486499
-        [2, 3]  =  0.809041
-
-    julia> for iter in eachindex(A)
-               @show iter.I_1, iter.I_2
-               @show A[iter]
-           end
-    (iter.I_1,iter.I_2) = (1,1)
-    A[iter] = 0.5988881393454597
-    (iter.I_1,iter.I_2) = (2,1)
-    A[iter] = 0.0
-    (iter.I_1,iter.I_2) = (1,2)
-    A[iter] = 0.02302469881746183
-    (iter.I_1,iter.I_2) = (2,2)
-    A[iter] = 0.0
-    (iter.I_1,iter.I_2) = (1,3)
-    A[iter] = 0.4864987874354343
-    (iter.I_1,iter.I_2) = (2,3)
-    A[iter] = 0.8090413606455655
+```jldoctest
+julia> A = sparse([1, 1, 2], [1, 3, 1], [1, 2, -5])
+2x3 sparse matrix with 3 Int64 entries:
+        [1, 1]  =  1
+        [2, 1]  =  -5
+        [1, 3]  =  2
+
+julia> for iter in eachindex(A)
+           @show iter.I[1], iter.I[2]
+           @show A[iter]
+       end
+(iter.I[1],iter.I[2]) = (1,1)
+A[iter] = 1
+(iter.I[1],iter.I[2]) = (2,1)
+A[iter] = -5
+(iter.I[1],iter.I[2]) = (1,2)
+A[iter] = 0
+(iter.I[1],iter.I[2]) = (2,2)
+A[iter] = 0
+(iter.I[1],iter.I[2]) = (1,3)
+A[iter] = 2
+(iter.I[1],iter.I[2]) = (2,3)
+A[iter] = 0
+```
 
 If you supply more than one ``AbstractArray`` argument, ``eachindex``
 will create an iterable object that is fast for all arguments (a

doc/stdlib/arrays.rst

@@ -51,31 +51,30 @@ Basic functions
 
    Example for a sparse 2-d array:
 
-   .. code-block:: julia
+   .. doctest::
 
-       julia> A = sprand(2, 3, 0.5)
-       2x3 sparse matrix with 4 Float64 entries:
-           [1, 1]  =  0.598888
-           [1, 2]  =  0.0230247
-           [1, 3]  =  0.486499
-           [2, 3]  =  0.809041
+       julia> A = sparse([1, 1, 2], [1, 3, 1], [1, 2, -5])
+       2x3 sparse matrix with 3 Int64 entries:
+               [1, 1]  =  1
+               [2, 1]  =  -5
+               [1, 3]  =  2
 
        julia> for iter in eachindex(A)
-                  @show iter.I_1, iter.I_2
+                  @show iter.I[1], iter.I[2]
                   @show A[iter]
               end
-       (iter.I_1,iter.I_2) = (1,1)
-       A[iter] = 0.5988881393454597
-       (iter.I_1,iter.I_2) = (2,1)
-       A[iter] = 0.0
-       (iter.I_1,iter.I_2) = (1,2)
-       A[iter] = 0.02302469881746183
-       (iter.I_1,iter.I_2) = (2,2)
-       A[iter] = 0.0
-       (iter.I_1,iter.I_2) = (1,3)
-       A[iter] = 0.4864987874354343
-       (iter.I_1,iter.I_2) = (2,3)
-       A[iter] = 0.8090413606455655
+       (iter.I[1],iter.I[2]) = (1,1)
+       A[iter] = 1
+       (iter.I[1],iter.I[2]) = (2,1)
+       A[iter] = -5
+       (iter.I[1],iter.I[2]) = (1,2)
+       A[iter] = 0
+       (iter.I[1],iter.I[2]) = (2,2)
+       A[iter] = 0
+       (iter.I[1],iter.I[2]) = (1,3)
+       A[iter] = 2
+       (iter.I[1],iter.I[2]) = (2,3)
+       A[iter] = 0
 
    If you supply more than one ``AbstractArray`` argument, ``eachindex`` will create an iterable object that is fast for all arguments (a ``UnitRange`` if all inputs have fast linear indexing, a CartesianRange otherwise).  If the arrays have different sizes and/or dimensionalities, ``eachindex`` returns an iterable that spans the largest range along each dimension.
 

doc/stdlib/base.rst

@@ -861,8 +861,8 @@ System
    * ``detach::Bool``\ : If ``true`` (defaults to ``false``\ ), then the ``Cmd`` will be   run in a new process group, allowing it to outlive the ``julia`` process   and not have Ctrl-C passed to it.
    * ``windows_verbatim::Bool``\ : If ``true`` (defaults to ``false``\ ), then on Windows   the ``Cmd`` will send a command-line string to the process with no quoting   or escaping of arguments, even arguments containing spaces.  (On Windows,   arguments are sent to a program as a single "command-line" string, and   programs are responsible for parsing it into arguments.  By default,   empty arguments and arguments with spaces or tabs are quoted with double   quotes ``"`` in the command line, and ``\`` or ``"`` are preceded by backslashes.   ``windows_verbatim=true`` is useful for launching programs that parse their   command line in nonstandard ways.)  Has no effect on non-Windows systems.
    * ``windows_hide::Bool``\ : If ``true`` (defaults to ``false``\ ), then on Windows no   new console window is displayed when the ``Cmd`` is executed.  This has   no effect if a console is already open or on non-Windows systems.
-   * ``env``\ : Set environment variables to use when running the ``Cmd``\ .  ``env``          is either a dictionary mapping strings to strings, an array          of strings of the form ``"var=val"``\ , an array or tuple of ``"var"=>val``          pairs, or ``nothing``\ .  In order to modify (rather than replace)          the existing environment, create ``env`` by ``copy(ENV)`` and then          set ``env["var"]=val`` as desired.
-   * ``dir::AbstractString``\ : Specify a working directory for the command (instead    of the current directory).
+   * ``env``\ : Set environment variables to use when running the ``Cmd``\ .  ``env``   is either a dictionary mapping strings to strings, an array   of strings of the form ``"var=val"``\ , an array or tuple of ``"var"=>val``   pairs, or ``nothing``\ .  In order to modify (rather than replace)   the existing environment, create ``env`` by ``copy(ENV)`` and then   set ``env["var"]=val`` as desired.
+   * ``dir::AbstractString``\ : Specify a working directory for the command (instead   of the current directory).
 
    For any keywords that are not specified, the current settings from ``cmd`` are used.   Normally, to create a ``Cmd`` object in the first place, one uses backticks, e.g.
 

doc/stdlib/pkg.rst

@@ -109,7 +109,7 @@ Functions for package development (e.g. ``tag``, ``publish``, etc.) have been mo
 
    .. Docstring generated from Julia source
 
-   Checkout the ``Pkg.dir(pkg)`` repo to the branch ``branch``\ . Defaults to checking out the "master" branch. To go back to using the newest compatible released version, use ``Pkg.free(pkg)``\ . Changes are merged (fast-forward only) if the keyword argument ``merge == true``, and the latest version is pulled from the upsream repo if ``pull == true``\ .
+   Checkout the ``Pkg.dir(pkg)`` repo to the branch ``branch``\ . Defaults to checking out the "master" branch. To go back to using the newest compatible released version, use ``Pkg.free(pkg)``\ . Changes are merged (fast-forward only) if the keyword argument ``merge == true``\ , and the latest version is pulled from the upsream repo if ``pull == true``\ .
 
 .. function:: pin(pkg)