Skip to content

Commit

Permalink
Rebuild stdlib docs.
Browse files Browse the repository at this point in the history
The only significant changes here seem to be the loss of `.. note::`s.

Most other changes are extra `\ ` escapes at the end of inline code,
inline math, and links. Some code blocks have been indented by an extra
space, I've not managed to track down the cause of that, though they
should render the same anyway.

`make doctest` errors all look related to differences in backtrace line
numbers and aren't related to the changes in this commit.
  • Loading branch information
MichaelHatherly committed Dec 13, 2015
1 parent b378e9c commit a940db3
Show file tree
Hide file tree
Showing 16 changed files with 794 additions and 1,053 deletions.
67 changes: 28 additions & 39 deletions doc/stdlib/arrays.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Basic functions

.. Docstring generated from Julia source
Returns the number of dimensions of ``A``
Returns the number of dimensions of ``A``\ .

.. function:: size(A, [dim...])

Expand Down Expand Up @@ -100,7 +100,7 @@ Basic functions

.. Docstring generated from Julia source
Convert an array to its complex conjugate in-place
Convert an array to its complex conjugate in-place.

.. function:: stride(A, k)

Expand All @@ -112,7 +112,7 @@ Basic functions

.. Docstring generated from Julia source
Returns a tuple of the memory strides in each dimension
Returns a tuple of the memory strides in each dimension.

.. function:: ind2sub(dims, index) -> subscripts

Expand All @@ -126,13 +126,13 @@ Basic functions

.. Docstring generated from Julia source
Returns a tuple of subscripts into array ``a`` corresponding to the linear index ``index``
Returns a tuple of subscripts into array ``a`` corresponding to the linear index ``index``\ .

.. function:: sub2ind(dims, i, j, k...) -> index

.. Docstring generated from Julia source
The inverse of ``ind2sub``\ , returns the linear index corresponding to the provided subscripts
The inverse of ``ind2sub``\ , returns the linear index corresponding to the provided subscripts.

Constructors
------------
Expand All @@ -147,7 +147,7 @@ Constructors

.. Docstring generated from Julia source
Construct a 1-d array of the specified type. This is usually called with the syntax ``Type[]``. Element values can be specified using ``Type[a,b,c,...]``.
Construct a 1-d array of the specified type. This is usually called with the syntax ``Type[]``\ . Element values can be specified using ``Type[a,b,c,...]``\ .

.. function:: cell(dims)

Expand Down Expand Up @@ -183,13 +183,13 @@ Constructors

.. Docstring generated from Julia source
Create a ``BitArray`` with all values set to ``true``
Create a ``BitArray`` with all values set to ``true``\ .

.. function:: falses(dims)

.. Docstring generated from Julia source
Create a ``BitArray`` with all values set to ``false``
Create a ``BitArray`` with all values set to ``false``\ .

.. function:: fill(x, dims)

Expand Down Expand Up @@ -255,13 +255,13 @@ Constructors

.. Docstring generated from Julia source
``n``\ -by-``n`` identity matrix
``n``\ -by-``n`` identity matrix.

.. function:: eye(m, n)

.. Docstring generated from Julia source
``m``\ -by-``n`` identity matrix
``m``\ -by-``n`` identity matrix.

.. function:: eye(A)

Expand Down Expand Up @@ -323,25 +323,25 @@ Indexing, Assignment, and Concatenation

.. Docstring generated from Julia source
Returns a subset of array ``A`` as specified by ``inds``, where each ``ind`` may be an ``Int``, a ``Range``, or a ``Vector``. See the manual section on :ref:`array indexing <man-array-indexing>` for details.
Returns a subset of array ``A`` as specified by ``inds``\ , where each ``ind`` may be an ``Int``\ , a ``Range``\ , or a ``Vector``\ . See the manual section on :ref:`array indexing <man-array-indexing>` for details.

.. function:: sub(A, inds...)

.. Docstring generated from Julia source
Like :func:`getindex`, but returns a view into the parent array ``A`` with the given indices instead of making a copy. Calling :func:`getindex` or :func:`setindex!` on the returned :obj:`SubArray` computes the indices to the parent array on the fly without checking bounds.
Like :func:`getindex`\ , but returns a view into the parent array ``A`` with the given indices instead of making a copy. Calling :func:`getindex` or :func:`setindex!` on the returned :obj:`SubArray` computes the indices to the parent array on the fly without checking bounds.

.. function:: parent(A)

.. Docstring generated from Julia source
Returns the "parent array" of an array view type (e.g., ``SubArray``\ ), or the array itself if it is not a view
Returns the "parent array" of an array view type (e.g., ``SubArray``\ ), or the array itself if it is not a view.

.. function:: parentindexes(A)

.. Docstring generated from Julia source
From an array view ``A``\ , returns the corresponding indexes in the parent
From an array view ``A``\ , returns the corresponding indexes in the parent.

.. function:: slicedim(A, d, i)

Expand All @@ -353,7 +353,7 @@ Indexing, Assignment, and Concatenation

.. Docstring generated from Julia source
Returns a view of array ``A`` with the given indices like :func:`sub`, but drops all dimensions indexed with scalars.
Returns a view of array ``A`` with the given indices like :func:`sub`\ , but drops all dimensions indexed with scalars.

.. function:: setindex!(A, X, inds...)

Expand Down Expand Up @@ -383,13 +383,13 @@ Indexing, Assignment, and Concatenation

.. Docstring generated from Julia source
Concatenate along dimension 1
Concatenate along dimension 1.

.. function:: hcat(A...)

.. Docstring generated from Julia source
Concatenate along dimension 2
Concatenate along dimension 2.

.. function:: hvcat(rows::Tuple{Vararg{Int}}, values...)

Expand Down Expand Up @@ -544,7 +544,7 @@ Indexing, Assignment, and Concatenation

.. Docstring generated from Julia source
Like :func:`permutedims`, except the inverse of the given permutation is applied.
Like :func:`permutedims`\ , except the inverse of the given permutation is applied.

.. function:: permutedims!(dest, src, perm)

Expand Down Expand Up @@ -601,10 +601,7 @@ Array functions

.. Docstring generated from Julia source
Cumulative product along a dimension ``dim`` (defaults to 1).
See also :func:`cumprod!` to use a preallocated output array,
both for performance and to control the precision of the
output (e.g. to avoid overflow).
Cumulative product along a dimension ``dim`` (defaults to 1). See also :func:`cumprod!` to use a preallocated output array, both for performance and to control the precision of the output (e.g. to avoid overflow).

.. function:: cumprod!(B, A, [dim])

Expand All @@ -616,10 +613,7 @@ Array functions

.. Docstring generated from Julia source
Cumulative sum along a dimension ``dim`` (defaults to 1).
See also :func:`cumsum!` to use a preallocated output array,
both for performance and to control the precision of the
output (e.g. to avoid overflow).
Cumulative sum along a dimension ``dim`` (defaults to 1). See also :func:`cumsum!` to use a preallocated output array, both for performance and to control the precision of the output (e.g. to avoid overflow).

.. function:: cumsum!(B, A, [dim])

Expand Down Expand Up @@ -726,8 +720,7 @@ Combinatorics

.. Docstring generated from Julia source
Construct a random permutation of length ``n``. The optional ``rng`` argument
specifies a random number generator, see :ref:`Random Numbers <random-numbers>`.
Construct a random permutation of length ``n``\ . The optional ``rng`` argument specifies a random number generator, see :ref:`Random Numbers <random-numbers>`\ .

.. function:: invperm(v)

Expand Down Expand Up @@ -759,23 +752,19 @@ Combinatorics

.. Docstring generated from Julia source
Construct a random cyclic permutation of length ``n``. The optional ``rng``
argument specifies a random number generator, see :ref:`Random Numbers
<random-numbers>`.
Construct a random cyclic permutation of length ``n``\ . The optional ``rng`` argument specifies a random number generator, see :ref:`Random Numbers <random-numbers>`\ .

.. function:: shuffle([rng,] v)

.. Docstring generated from Julia source
Return a randomly permuted copy of ``v``. The optional ``rng`` argument
specifies a random number generator, see :ref:`Random Numbers
<random-numbers>`.
Return a randomly permuted copy of ``v``\ . The optional ``rng`` argument specifies a random number generator, see :ref:`Random Numbers <random-numbers>`\ .

.. function:: shuffle!([rng,] v)

.. Docstring generated from Julia source
In-place version of :func:`shuffle`.
In-place version of :func:`shuffle`\ .

.. function:: reverse(v [, start=1 [, stop=length(v) ]] )

Expand All @@ -793,7 +782,7 @@ Combinatorics

.. Docstring generated from Julia source
In-place version of :func:`reverse`.
In-place version of :func:`reverse`\ .

BitArrays
---------
Expand All @@ -802,19 +791,19 @@ BitArrays

.. Docstring generated from Julia source
Converts a numeric array to a packed boolean array
Converts a numeric array to a packed boolean array.

.. function:: bitunpack(B::BitArray{N}) -> Array{Bool,N}

.. Docstring generated from Julia source
Converts a packed boolean array to an array of booleans
Converts a packed boolean array to an array of booleans.

.. function:: flipbits!(B::BitArray{N}) -> BitArray{N}

.. Docstring generated from Julia source
Performs a bitwise not operation on ``B``. See :ref:`~ operator <~>`.
Performs a bitwise not operation on ``B``\ . See :ref:`~ operator <~>`\ .

.. function:: rol!(dest::BitArray{1}, src::BitArray{1}, i::Integer) -> BitArray{1}

Expand Down
Loading

0 comments on commit a940db3

Please sign in to comment.