Skip to content

Commit 3473a4a

Browse files
Merge pull request #61 from SciML/as/symeval-kwargs
docs: allow `symbolic_evaluate` to have arbitrary kwargs
2 parents 584bf3d + d276ade commit 3473a4a

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/trait.jl

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Get the name of a symbolic variable as a `Symbol`
6262
function getname end
6363

6464
"""
65-
symbolic_evaluate(expr, syms::Dict)
65+
symbolic_evaluate(expr, syms::Dict; kwargs...)
6666
6767
Return the value of symbolic expression `expr` where the values of variables involved are
6868
obtained from the dictionary `syms`. The keys of `syms` are symbolic variables (not
@@ -72,6 +72,9 @@ expressions.
7272
The returned value should either be a value or an expression involving symbolic variables
7373
not present as keys in `syms`.
7474
75+
The function can take additional keyword arguments to control implementation-specific
76+
behavior.
77+
7578
This is already implemented for
7679
`symbolic_evaluate(expr::Union{Symbol, Expr}, syms::Dict)`.
7780
"""

0 commit comments

Comments
 (0)