Skip to content

Commit bd5d5a0

Browse files
kshyattfredrikekre
authored andcommitted
Add some backticks and links (#25018)
1 parent b5c6263 commit bd5d5a0

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

doc/src/devdocs/subarrays.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ expands to
139139
Base.reindex(S1, S1.indexes, (i, j)) == (i, S1.indexes[2], S1.indexes[3][j])
140140
```
141141

142-
for any pair of indices `(i,j)` (except `CartesianIndex`s and arrays thereof, see below).
142+
for any pair of indices `(i,j)` (except [`CartesianIndex`](@ref)s and arrays thereof, see below).
143143

144144
This is the core of a `SubArray`; indexing methods depend upon `reindex` to do this index translation.
145145
Sometimes, though, we can avoid the indirection and make it even faster.
@@ -240,7 +240,7 @@ then `A[2:2:4,:]` does not have uniform stride, so we cannot guarantee efficient
240240
if possible. Consequently, `view` ensures that the parent array is the appropriate dimensionality
241241
for the given indices by reshaping it if needed. The inner `SubArray` constructor ensures that
242242
this invariant is satisfied.
243-
* `CartesianIndex` and arrays thereof throw a nasty wrench into the `reindex` scheme. Recall that
243+
* [`CartesianIndex`](@ref) and arrays thereof throw a nasty wrench into the `reindex` scheme. Recall that
244244
`reindex` simply dispatches on the type of the stored indices in order to determine how many passed
245245
indices should be used and where they should go. But with `CartesianIndex`, there's no longer
246246
a one-to-one correspondence between the number of passed arguments and the number of dimensions

doc/src/manual/parallel-computing.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1118,7 +1118,7 @@ unspecified, i.e, with the `--worker` option, the worker tries to read it from i
11181118
`LocalManager` and `SSHManager` both pass the cookie to newly launched workers via their
11191119
standard inputs.
11201120

1121-
By default a worker will listen on a free port at the address returned by a call to `getipaddr()`.
1121+
By default a worker will listen on a free port at the address returned by a call to [`getipaddr()`](@ref).
11221122
A specific address to listen on may be specified by optional argument `--bind-to bind_addr[:port]`.
11231123
This is useful for multi-homed hosts.
11241124

@@ -1213,7 +1213,7 @@ the other to write data that needs to be sent to worker `pid`. Custom cluster ma
12131213
an in-memory `BufferStream` as the plumbing to proxy data between the custom, possibly non-`IO`
12141214
transport and Julia's in-built parallel infrastructure.
12151215

1216-
A `BufferStream` is an in-memory `IOBuffer` which behaves like an `IO`--it is a stream which can
1216+
A `BufferStream` is an in-memory [`IOBuffer`](@ref) which behaves like an `IO`--it is a stream which can
12171217
be handled asynchronously.
12181218

12191219
Folder `examples/clustermanager/0mq` contains an example of using ZeroMQ to connect Julia workers
@@ -1228,7 +1228,7 @@ When using custom transports:
12281228
* For every incoming logical connection with a worker, `Base.process_messages(rd::IO, wr::IO)()`
12291229
must be called. This launches a new task that handles reading and writing of messages from/to
12301230
the worker represented by the `IO` objects.
1231-
* `init_worker(cookie, manager::FooManager)` MUST be called as part of worker process initialization.
1231+
* `init_worker(cookie, manager::FooManager)` *must* be called as part of worker process initialization.
12321232
* Field `connect_at::Any` in `WorkerConfig` can be set by the cluster manager when [`launch`](@ref)
12331233
is called. The value of this field is passed in in all [`connect`](@ref) callbacks. Typically,
12341234
it carries information on *how to connect* to a worker. For example, the TCP/IP socket transport
@@ -1272,7 +1272,7 @@ requirements for the inbuilt `LocalManager` and `SSHManager`:
12721272
the ephemeral port range (varies by OS).
12731273

12741274
Securing and encrypting all worker-worker traffic (via SSH) or encrypting individual messages
1275-
can be done via a custom ClusterManager.
1275+
can be done via a custom `ClusterManager`.
12761276

12771277
## Cluster Cookie
12781278

@@ -1285,8 +1285,8 @@ on the master process:
12851285
are allowed to connect to each other.
12861286
* The cookie may be passed to the workers at startup via argument `--worker=<cookie>`. If argument
12871287
`--worker` is specified without the cookie, the worker tries to read the cookie from its
1288-
standard input (STDIN). The STDIN is closed immediately after the cookie is retrieved.
1289-
* ClusterManagers can retrieve the cookie on the master by calling [`Base.cluster_cookie()`](@ref).
1288+
standard input ([`STDIN`](@ref)). The `STDIN` is closed immediately after the cookie is retrieved.
1289+
* `ClusterManager`s can retrieve the cookie on the master by calling [`Base.cluster_cookie()`](@ref).
12901290
Cluster managers not using the default TCP/IP transport (and hence not specifying `--worker`)
12911291
must call `init_worker(cookie, manager)` with the same cookie as on the master.
12921292

@@ -1423,7 +1423,7 @@ Note that while Julia code runs on a single thread (by default), libraries used
14231423
their own internal threads. For example, the BLAS library may start as many threads as there are
14241424
cores on a machine.
14251425

1426-
The `@threadcall` macro addresses scenarios where we do not want a `ccall` to block the main Julia
1426+
The [`@threadcall`](@ref) macro addresses scenarios where we do not want a [`ccall`](@ref) to block the main Julia
14271427
event loop. It schedules a C function for execution in a separate thread. A threadpool with a
14281428
default size of 4 is used for this. The size of the threadpool is controlled via environment variable
14291429
`UV_THREADPOOL_SIZE`. While waiting for a free thread, and during function execution once a thread

0 commit comments

Comments
 (0)