Skip to content

Commit d837ff6

Browse files
committed
Update documentation
1 parent 7a2a259 commit d837ff6

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

src/input_speculators.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ julia> install_speculator(; limit = 2, verbosity = debug)
4848
[ Info The input speculator has been installed into the REPL
4949
5050
julia> f() = nothing;
51-
[ Info: Compiled `Main.Example.f()`
51+
[ Info: Compiled `Main.f()`
5252
5353
julia> g(::Union{String, Symbol}) = nothing;
54-
[ Info: Compiled `Main.Example.g(::String)`
55-
[ Info: Compiled `Main.Example.g(::Symbol)`
54+
[ Info: Compiled `Main.g(::String)`
55+
[ Info: Compiled `Main.g(::Symbol)`
5656
```
5757
"""
5858
function install_speculator(

src/speculate.jl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ See also [`install_speculator`](@ref).
186186
- `predicate = Returns(true)`:
187187
This must accept the signature `predicate(::Module,\u00A0::Symbol)::Bool`.
188188
Returning `true` specifies to search `getproperty(::Module,\u00A0::Symbol)`,
189-
whereas returning `false` specifies to ignore the value.
189+
whereas returning `false` specifies to skip the value.
190190
This is called when searching the names of a `Module` if the
191191
given module and name satisfy `isdefined` and `!isdeprecated`.
192192
The default predicate `Returns(true)` will search every value,
@@ -208,15 +208,15 @@ See also [`install_speculator`](@ref).
208208
The number of available threads can be determined using `Threads.nthreads(:default)`.
209209
- `dry::Bool = false`:
210210
Specifies whether to run `precompile` on generated method signatures.
211-
This is useful for testing workloads with `verbosity\u00A0=\u00A0debug\u00A0∪\u00A0review`.
212-
Methods that are known to be specialized are skipped.
211+
This is useful for testing with `verbosity\u00A0=\u00A0debug\u00A0∪\u00A0review`.
212+
Method signatures that are known to be specialized are skipped.
213213
Note that `dry` must be `false` to save the directives to a file with the `path` parameter.
214214
- `limit::Int = $default_limit`:
215215
Specifies the maximum number of compilable methods that are generated from a generic method.
216216
Values less than `1` will throw an error.
217217
Otherwise, method signatures will be generated from the Cartesian product each parameter type.
218-
Types marked with `@nospecialize` are used directly.
219-
Otherwise, compilable types are obtained from the subtypes of `DataType` and `Union`.
218+
Concrete types and those marked with `@nospecialize` are used directly.
219+
Otherwise, concrete types are obtained from the subtypes of `DataType` and `Union`.
220220
Setting an appropriate value prevents spending too
221221
much time precompiling a single generic method.
222222
- `path::String = ""`:

0 commit comments

Comments
 (0)