Skip to content

Commit 8c24dc4

Browse files
committed
Add mention of context in the docstring of Model
1 parent a974e36 commit 8c24dc4

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/model.jl

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
"""
2-
struct Model{F,argnames,defaultnames,missings,Targs,Tdefaults}
2+
struct Model{F,argnames,defaultnames,missings,Targs,Tdefaults,Ctx<:AbstactContext}
33
f::F
44
args::NamedTuple{argnames,Targs}
55
defaults::NamedTuple{defaultnames,Tdefaults}
6+
context::Ctx
67
end
78
89
A `Model` struct with model evaluation function of type `F`, arguments of names `argnames`
9-
types `Targs`, default arguments of names `defaultnames` with types `Tdefaults`, and missing
10-
arguments `missings`.
10+
types `Targs`, default arguments of names `defaultnames` with types `Tdefaults`, missing
11+
arguments `missings`, and evaluation context of type `Ctx`.
1112
1213
Here `argnames`, `defaultargnames`, and `missings` are tuples of symbols, e.g. `(:a, :b)`.
14+
`context` is by default `DefaultContext()`.
1315
1416
An argument with a type of `Missing` will be in `missings` by default. However, in
1517
non-traditional use-cases `missings` can be defined differently. All variables in `missings`

0 commit comments

Comments
 (0)