Skip to content

Commit d3536a3

Browse files
StefanKarpinskitkelman
StefanKarpinski
authored and
tkelman
committed
docs: various ReStructured text formatting fixes
(cherry picked from commit fe5de8e)
1 parent a1766aa commit d3536a3

10 files changed

+30
-32
lines changed

‎base/docs/helpdb.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4118,7 +4118,7 @@ Compute the LU factorization of ``A``. The return type of ``F`` depends on the t
41184118
41194119
======================= ========================= ========================================
41204120
Type of input ``A`` Type of output ``F`` Relationship between ``F`` and ``A``
4121-
----------------------- ------------------------- ----------------------------------------
4121+
======================= ========================= ========================================
41224122
:func:`Matrix` ``LU`` ``F[:L]*F[:U] == A[F[:p], :]``
41234123
:func:`Tridiagonal` ``LU{T,Tridiagonal{T}}`` ``F[:L]*F[:U] == A[F[:p], :]``
41244124
:func:`SparseMatrixCSC` ``UmfpackLU`` ``F[:L]*F[:U] == (F[:Rs] .* A)[F[:p], F[:q]]``
@@ -4128,7 +4128,7 @@ The individual components of the factorization ``F`` can be accessed by indexing
41284128
41294129
=========== ======================================= ====== ======================== =============
41304130
Component Description ``LU`` ``LU{T,Tridiagonal{T}}`` ``UmfpackLU``
4131-
----------- --------------------------------------- ------ ------------------------ -------------
4131+
=========== ======================================= ====== ======================== =============
41324132
``F[:L]`` ``L`` (lower triangular) part of ``LU`` ✓ ✓ ✓
41334133
``F[:U]`` ``U`` (upper triangular) part of ``LU`` ✓ ✓ ✓
41344134
``F[:p]`` (right) permutation ``Vector`` ✓ ✓ ✓
@@ -4140,7 +4140,7 @@ Component Description ``LU`` ``LU{T,Tridiagonal{T}
41404140
41414141
================== ====== ======================== =============
41424142
Supported function ``LU`` ``LU{T,Tridiagonal{T}}`` ``UmfpackLU``
4143-
------------------ ------ ------------------------ -------------
4143+
================== ====== ======================== =============
41444144
``/`` ✓
41454145
``\`` ✓ ✓ ✓
41464146
``cond`` ✓ ✓
@@ -10017,7 +10017,7 @@ Computes the QR factorization of ``A``. The return type of ``F`` depends on the
1001710017
1001810018
================ ================= ============== =====================================
1001910019
Return type ``eltype(A)`` ``pivot`` Relationship between ``F`` and ``A``
10020-
---------------- ----------------- -------------- -------------------------------------
10020+
================ ================= ============== =====================================
1002110021
``QR`` not ``BlasFloat`` either ``A==F[:Q]*F[:R]``
1002210022
``QRCompactWY`` ``BlasFloat`` ``Val{false}`` ``A==F[:Q]*F[:R]``
1002310023
``QRPivoted`` ``BlasFloat`` ``Val{true}`` ``A[:,F[:p]]==F[:Q]*F[:R]``
@@ -10029,7 +10029,7 @@ The individual components of the factorization ``F`` can be accessed by indexing
1002910029
1003010030
=========== ============================================= ================== ===================== ==================
1003110031
Component Description ``QR`` ``QRCompactWY`` ``QRPivoted``
10032-
----------- --------------------------------------------- ------------------ --------------------- ------------------
10032+
=========== ============================================= ================== ===================== ==================
1003310033
``F[:Q]`` ``Q`` (orthogonal/unitary) part of ``QR`` ✓ (``QRPackedQ``) ✓ (``QRCompactWYQ``) ✓ (``QRPackedQ``)
1003410034
``F[:R]`` ``R`` (upper right triangular) part of ``QR`` ✓ ✓ ✓
1003510035
``F[:p]`` pivot ``Vector`` ✓
@@ -11415,7 +11415,7 @@ the ``format`` string. The following codes can be used for constructing format s
1141511415
1141611416
=============== ========= ===============================================================
1141711417
Code Matches Comment
11418-
--------------- --------- ---------------------------------------------------------------
11418+
=============== ========= ===============================================================
1141911419
``y`` 1996, 96 Returns year of 1996, 0096
1142011420
``m`` 1, 01 Matches 1 or 2-digit months
1142111421
``u`` Jan Matches abbreviated months according to the ``locale`` keyword

‎base/linalg/arnoldi.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The following keyword arguments are supported:
1919
2020
========= ======================================================================================================================
2121
``which`` type of eigenvalues
22-
--------- ----------------------------------------------------------------------------------------------------------------------
22+
========= ======================================================================================================================
2323
``:LM`` eigenvalues of largest magnitude (default)
2424
``:SM`` eigenvalues of smallest magnitude
2525
``:LR`` eigenvalues of largest real part
@@ -41,7 +41,7 @@ The following keyword arguments are supported:
4141
4242
=============== ================================== ==================================
4343
``sigma`` iteration mode ``which`` refers to eigenvalues of
44-
--------------- ---------------------------------- ----------------------------------
44+
=============== ================================== ==================================
4545
``nothing`` ordinary (forward) :math:`A`
4646
real or complex inverse with level shift ``sigma`` :math:`(A - \sigma I )^{-1}`
4747
=============== ================================== ==================================
@@ -66,7 +66,7 @@ The following keyword arguments are supported:
6666
6767
========= ======================================================================================================================
6868
``which`` type of eigenvalues
69-
--------- ----------------------------------------------------------------------------------------------------------------------
69+
========= ======================================================================================================================
7070
``:LM`` eigenvalues of largest magnitude (default)
7171
``:SM`` eigenvalues of smallest magnitude
7272
``:LR`` eigenvalues of largest real part

‎doc/devdocs/stdio.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,6 @@ This is needed because :c:func:`jl_printf` caller :c:func:`jl_static_show`
120120
is passed an :code:`ios_t` stream by femtolisp's :c:func:`fl_print` function.
121121
Julia's :c:func:`jl_write` function has special handling for this::
122122

123-
```c
124-
if (stream->type > UV_HANDLE_TYPE_MAX) {
125-
return ios_write((ios_t*)stream, str, n);
126-
}
127-
```
123+
if (stream->type > UV_HANDLE_TYPE_MAX) {
124+
return ios_write((ios_t*)stream, str, n);
125+
}

‎doc/manual/arrays.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@ reference.
735735

736736
+----------------------------------------+----------------------------------+--------------------------------------------+
737737
| Sparse | Dense | Description |
738-
+----------------------------------------+----------------------------------+--------------------------------------------+
738+
+========================================+==================================+============================================+
739739
| :func:`spzeros(m,n) <spzeros>` | :func:`zeros(m,n) <zeros>` | Creates a *m*-by-*n* matrix of zeros. |
740740
| | | (:func:`spzeros(m,n) <spzeros>` is empty.) |
741741
+----------------------------------------+----------------------------------+--------------------------------------------+

‎doc/manual/integers-and-floating-point-numbers.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The following are Julia's primitive numeric types:
3030

3131
================ ======= ============== ============== ==================
3232
Type Signed? Number of bits Smallest value Largest value
33-
---------------- ------- -------------- -------------- ------------------
33+
================ ======= ============== ============== ==================
3434
:class:`Int8` ✓ 8 -2^7 2^7 - 1
3535
:class:`UInt8` 8 0 2^8 - 1
3636
:class:`Int16` ✓ 16 -2^15 2^15 - 1
@@ -48,7 +48,7 @@ Type Signed? Number of bits Smallest value Largest value
4848

4949
================ ========= ==============
5050
Type Precision Number of bits
51-
---------------- --------- --------------
51+
================ ========= ==============
5252
:class:`Float16` half_ 16
5353
:class:`Float32` single_ 32
5454
:class:`Float64` double_ 64
@@ -755,7 +755,7 @@ specified type or the type of a given variable.
755755

756756
====================== =====================================================
757757
Function Description
758-
---------------------- -----------------------------------------------------
758+
====================== =====================================================
759759
:func:`zero(x) <zero>` Literal zero of type ``x`` or type of variable ``x``
760760
:func:`one(x) <one>` Literal one of type ``x`` or type of variable ``x``
761761
====================== =====================================================

‎doc/manual/interfaces.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ The result of indexing an ``AbstractArray`` can itself be an array (for instance
265265
1.0 4.0 7.0
266266
2.0 5.0 8.0
267267

268-
In this example it is accomplished by defining ``Base.similar{T}(A::SparseArray, ::Type{T}, dims::Dims)`` to create the appropriate wrapped array. For this to work it's important that ``SparseArray`` is mutable (supports ``setindex!``). :func:`similar` is also used to allocate result arrays for arithmetic on ``AbstractArray``s, for instance:
268+
In this example it is accomplished by defining ``Base.similar{T}(A::SparseArray, ::Type{T}, dims::Dims)`` to create the appropriate wrapped array. For this to work it's important that ``SparseArray`` is mutable (supports ``setindex!``). :func:`similar` is also used to allocate result arrays for arithmetic on ``AbstractArrays``, for instance:
269269

270270
.. doctest::
271271

‎doc/manual/linear-algebra.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Elementary operations
6161
+-------------------------+-------+-------+-------+-------+--------------------------------+
6262
| Matrix type | ``+`` | ``-`` | ``*`` | ``\`` | Other functions with |
6363
| | | | | | optimized methods |
64-
+-------------------------+-------+-------+-------+-------+--------------------------------+
64+
+=========================+=======+=======+=======+=======+================================+
6565
| :class:`Hermitian` | | | | MV | :func:`inv`, |
6666
| | | | | | :func:`sqrtm`, :func:`expm` |
6767
+-------------------------+-------+-------+-------+-------+--------------------------------+

‎doc/manual/parallel-computing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -690,7 +690,7 @@ Connections between workers (using the in-built TCP/IP transport) is established
690690

691691
- :func:`addprocs` is called on the master process with a :obj:`ClusterManager` object
692692
- :func:`addprocs` calls the appropriate :func:`launch` method which spawns
693-
required number of worker processes on appropriate machines
693+
required number of worker processes on appropriate machines
694694
- Each worker starts listening on a free port and writes out its host, port information to :const:`STDOUT`
695695
- The cluster manager captures the stdout's of each worker and makes it available to the master process
696696
- The master process parses this information and sets up TCP/IP connections to each worker

‎doc/stdlib/dates.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ alternatively, you could call ``using Dates`` to bring all exported functions in
8686

8787
=============== ========= ===============================================================
8888
Code Matches Comment
89-
--------------- --------- ---------------------------------------------------------------
89+
=============== ========= ===============================================================
9090
``y`` 1996, 96 Returns year of 1996, 0096
9191
``m`` 1, 01 Matches 1 or 2-digit months
9292
``u`` Jan Matches abbreviated months according to the ``locale`` keyword
@@ -476,7 +476,7 @@ Days of the Week:
476476

477477
=============== ========= =============
478478
Variable Abbr. Value (Int)
479-
--------------- --------- -------------
479+
=============== ========= =============
480480
``Monday`` ``Mon`` 1
481481
``Tuesday`` ``Tue`` 2
482482
``Wednesday`` ``Wed`` 3
@@ -490,7 +490,7 @@ Months of the Year:
490490

491491
=============== ========= =============
492492
Variable Abbr. Value (Int)
493-
--------------- --------- -------------
493+
=============== ========= =============
494494
``January`` ``Jan`` 1
495495
``February`` ``Feb`` 2
496496
``March`` ``Mar`` 3

‎doc/stdlib/linalg.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f
7373

7474
======================= ========================= ========================================
7575
Type of input ``A`` Type of output ``F`` Relationship between ``F`` and ``A``
76-
----------------------- ------------------------- ----------------------------------------
76+
======================= ========================= ========================================
7777
:func:`Matrix` ``LU`` ``F[:L]*F[:U] == A[F[:p], :]``
7878
:func:`Tridiagonal` ``LU{T,Tridiagonal{T}}`` ``F[:L]*F[:U] == A[F[:p], :]``
7979
:func:`SparseMatrixCSC` ``UmfpackLU`` ``F[:L]*F[:U] == (F[:Rs] .* A)[F[:p], F[:q]]``
@@ -83,7 +83,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f
8383

8484
=========== ======================================= ====== ======================== =============
8585
Component Description ``LU`` ``LU{T,Tridiagonal{T}}`` ``UmfpackLU``
86-
----------- --------------------------------------- ------ ------------------------ -------------
86+
=========== ======================================= ====== ======================== =============
8787
``F[:L]`` ``L`` (lower triangular) part of ``LU`` ✓ ✓ ✓
8888
``F[:U]`` ``U`` (upper triangular) part of ``LU`` ✓ ✓ ✓
8989
``F[:p]`` (right) permutation ``Vector`` ✓ ✓ ✓
@@ -95,7 +95,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f
9595

9696
================== ====== ======================== =============
9797
Supported function ``LU`` ``LU{T,Tridiagonal{T}}`` ``UmfpackLU``
98-
------------------ ------ ------------------------ -------------
98+
================== ====== ======================== =============
9999
``/`` ✓
100100
``\`` ✓ ✓ ✓
101101
``cond`` ✓ ✓
@@ -175,7 +175,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f
175175

176176
================ ================= ============== =====================================
177177
Return type ``eltype(A)`` ``pivot`` Relationship between ``F`` and ``A``
178-
---------------- ----------------- -------------- -------------------------------------
178+
================ ================= ============== =====================================
179179
``QR`` not ``BlasFloat`` either ``A==F[:Q]*F[:R]``
180180
``QRCompactWY`` ``BlasFloat`` ``Val{false}`` ``A==F[:Q]*F[:R]``
181181
``QRPivoted`` ``BlasFloat`` ``Val{true}`` ``A[:,F[:p]]==F[:Q]*F[:R]``
@@ -187,7 +187,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f
187187

188188
=========== ============================================= ================== ===================== ==================
189189
Component Description ``QR`` ``QRCompactWY`` ``QRPivoted``
190-
----------- --------------------------------------------- ------------------ --------------------- ------------------
190+
=========== ============================================= ================== ===================== ==================
191191
``F[:Q]`` ``Q`` (orthogonal/unitary) part of ``QR`` ✓ (``QRPackedQ``) ✓ (``QRCompactWYQ``) ✓ (``QRPackedQ``)
192192
``F[:R]`` ``R`` (upper right triangular) part of ``QR`` ✓ ✓ ✓
193193
``F[:p]`` pivot ``Vector`` ✓
@@ -934,7 +934,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f
934934

935935
========= ======================================================================================================================
936936
``which`` type of eigenvalues
937-
--------- ----------------------------------------------------------------------------------------------------------------------
937+
========= ======================================================================================================================
938938
``:LM`` eigenvalues of largest magnitude (default)
939939
``:SM`` eigenvalues of smallest magnitude
940940
``:LR`` eigenvalues of largest real part
@@ -956,7 +956,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f
956956

957957
=============== ================================== ==================================
958958
``sigma`` iteration mode ``which`` refers to eigenvalues of
959-
--------------- ---------------------------------- ----------------------------------
959+
=============== ================================== ==================================
960960
``nothing`` ordinary (forward) :math:`A`
961961
real or complex inverse with level shift ``sigma`` :math:`(A - \sigma I )^{-1}`
962962
=============== ================================== ==================================
@@ -977,7 +977,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f
977977

978978
========= ======================================================================================================================
979979
``which`` type of eigenvalues
980-
--------- ----------------------------------------------------------------------------------------------------------------------
980+
========= ======================================================================================================================
981981
``:LM`` eigenvalues of largest magnitude (default)
982982
``:SM`` eigenvalues of smallest magnitude
983983
``:LR`` eigenvalues of largest real part

0 commit comments

Comments
 (0)