Skip to content

Commit fb2cc5a

Browse files
committed
fix docs
1 parent 74de329 commit fb2cc5a

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/src/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# API Reference
22

33
```@docs
4-
MadDiff.diff_optimizer
4+
MadDiff.diff_model
55
MadDiff.MadDiffSolver
66
MadDiff.MadDiffConfig
77
MadDiff.reset_sensitivity_cache!

src/MadDiff.jl

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ export jacobian_vector_product!, vector_jacobian_product!
5454
export jacobian!, jacobian_transpose!
5555
export reset_sensitivity_cache!
5656

57+
"""
58+
diff_model(optimizer_constructor; kwargs...)
59+
60+
Create a JuMP Model with MadDiff wrapping `optimizer_constructor`.
61+
"""
5762
function diff_model(args...; kwargs...)
5863
error(
5964
"`MadDiff.diff_model` requires the `DiffOpt` extension. " *

0 commit comments

Comments
 (0)