Skip to content

Commit 9d913df

Browse files
authored
fix some docstring formatting (#48)
- `compile_workload` needs to be code-quoted to avoid interpreting `_` as beginning italics - Make "xref" link to julia issue an actual link
1 parent 301a188 commit 9d913df

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/workloads.jl

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ end
1515
check_edges(node)
1616
1717
Recursively ensure that all callees of `node` are precompiled. This is (rarely) necessary
18-
because sometimes there is no backedge from callee to caller (xref https://github.com/JuliaLang/julia/issues/49617),
18+
because sometimes there is no backedge from callee to caller (xref [JuliaLang/julia#49617](https://github.com/JuliaLang/julia/issues/49617)),
1919
and `staticdata.c` relies on the backedge to trace back to a MethodInstance that is tagged `mi.precompiled`.
2020
"""
2121
function check_edges(node)
@@ -40,13 +40,13 @@ end
4040
"""
4141
@compile_workload f(args...)
4242
43-
`precompile` (and save in the compile_workload file) any method-calls that occur inside the expression. All calls (direct or indirect) inside a
43+
`precompile` (and save in the `compile_workload` file) any method-calls that occur inside the expression. All calls (direct or indirect) inside a
4444
`@compile_workload` block will be cached.
4545
4646
`@compile_workload` has three key features:
4747
4848
1. code inside runs only when the package is being precompiled (i.e., a `*.ji`
49-
precompile compile_workload file is being written)
49+
precompile `compile_workload` file is being written)
5050
2. the interpreter is disabled, ensuring your calls will be compiled
5151
3. both direct and indirect callees will be precompiled, even for methods defined in other packages
5252
and even for runtime-dispatched callees (requires Julia 1.8 and above).

0 commit comments

Comments
 (0)