Skip to content

Commit 6bbf4f4

Browse files
Add solver docstring references to the problem docstring
Continuing #3857
1 parent b0907ec commit 6bbf4f4

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/problems/docs.jl

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,10 @@ function function_docstring(func, istd, optionals)
216216
function should be in-place. `specialization` is a `SciMLBase.AbstractSpecalize`
217217
subtype indicating the level of specialization of the $func.
218218
219+
Beyond the arguments listed below, this constructor accepts all keyword arguments
220+
supported by the DifferentialEquations.jl `solve` function. For a complete list
221+
and detailed descriptions, see the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
222+
219223
# Keyword arguments
220224
221225
- `u0`: The `u0` vector for the corresponding problem, if available. Can be obtained
@@ -232,6 +236,7 @@ function function_docstring(func, istd, optionals)
232236
sparse matrices. Also controls whether the mass matrix is sparse, wherever applicable.
233237
$(prob_fun_common_kwargs(func, istd))
234238
$(process_optional_function_kwargs(optionals))
239+
- `kwargs...`: Additional keyword arguments passed to the solver
235240
236241
All other keyword arguments are forwarded to the `$func` struct constructor.
237242
"""

0 commit comments

Comments
 (0)