Skip to content

Commit 244e0a3

Browse files
Merge pull request #110 from ChrisRackauckas-Claude/docs-improvements-20260101-231946
Documentation improvements: fix typos and grammar
2 parents 4456e36 + db0645c commit 244e0a3

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ no_worldage()
5353
## Changing how global symbols are looked up
5454

5555
If you want to use helper functions or global variables from a different
56-
module within your function expression you'll need to pass a `context_module`
57-
to the `@RuntimeGeneratedFunction` constructor. For example
56+
module within your function expression, you'll need to pass a `context_module`
57+
to the `@RuntimeGeneratedFunction` constructor. For example:
5858

5959
```julia
6060
RuntimeGeneratedFunctions.init(@__MODULE__)
@@ -75,14 +75,14 @@ end
7575

7676
## Precompilation and setting the function expression cache
7777

78-
For technical reasons RuntimeGeneratedFunctions needs to cache the function
78+
For technical reasons, RuntimeGeneratedFunctions needs to cache the function
7979
expression in a global variable within some module. This is normally
8080
transparent to the user, but if the `RuntimeGeneratedFunction` is evaluated
8181
during module precompilation, the cache module must be explicitly set to the
8282
module currently being precompiled. This is relevant for helper functions in
83-
some module which construct a RuntimeGeneratedFunction on behalf of the user.
83+
some module which constructs a RuntimeGeneratedFunction on behalf of the user.
8484
For example, in the following code, any third party user of
85-
`HelperModule.construct_rgf()` user needs to pass their own module as the
85+
`HelperModule.construct_rgf()` needs to pass their own module as the
8686
`cache_module` if they want the returned function to work after precompilation:
8787

8888
```julia

docs/src/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ no_worldage()
4545

4646
If you want to use helper functions or global variables from a different
4747
module within your function expression, you'll need to pass a `context_module`
48-
to the `@RuntimeGeneratedFunction` constructor. For example
48+
to the `@RuntimeGeneratedFunction` constructor. For example:
4949

5050
```julia
5151
RuntimeGeneratedFunctions.init(@__MODULE__)
@@ -71,9 +71,9 @@ expression in a global variable within some module. This is normally
7171
transparent to the user, but if the `RuntimeGeneratedFunction` is evaluated
7272
during module precompilation, the cache module must be explicitly set to the
7373
module currently being precompiled. This is relevant for helper functions in
74-
some module, which construct a RuntimeGeneratedFunction on behalf of the user.
74+
some module which constructs a RuntimeGeneratedFunction on behalf of the user.
7575
For example, in the following code, any third party user of
76-
`HelperModule.construct_rgf()` user needs to pass their own module as the
76+
`HelperModule.construct_rgf()` needs to pass their own module as the
7777
`cache_module` if they want the returned function to work after precompilation:
7878

7979
```julia

src/RuntimeGeneratedFunctions.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ struct RuntimeGeneratedFunction{argnames, cache_tag, context_tag, id, B} <: Func
6565
new{Tuple(args), cache_tag, context_tag, id, typeof(cached_body)}(cached_body)
6666
end
6767

68-
# For internal use in deserialize() - doesen't check whether the body is in the cache!
68+
# For internal use in deserialize() - doesn't check whether the body is in the cache!
6969
function RuntimeGeneratedFunction{
7070
argnames,
7171
cache_tag,

0 commit comments

Comments
 (0)