From 6bbf4f44404535b6cf768db76623003ed9174f5d Mon Sep 17 00:00:00 2001 From: Christopher Rackauckas Date: Wed, 30 Jul 2025 15:16:54 -0400 Subject: [PATCH] Add solver docstring references to the problem docstring Continuing https://github.com/SciML/ModelingToolkit.jl/pull/3857 --- src/problems/docs.jl | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/problems/docs.jl b/src/problems/docs.jl index 17bc2c83c6..11ed314333 100644 --- a/src/problems/docs.jl +++ b/src/problems/docs.jl @@ -216,6 +216,10 @@ function function_docstring(func, istd, optionals) function should be in-place. `specialization` is a `SciMLBase.AbstractSpecalize` subtype indicating the level of specialization of the $func. + Beyond the arguments listed below, this constructor accepts all keyword arguments + supported by the DifferentialEquations.jl `solve` function. For a complete list + and detailed descriptions, see the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/). + # Keyword arguments - `u0`: The `u0` vector for the corresponding problem, if available. Can be obtained @@ -232,6 +236,7 @@ function function_docstring(func, istd, optionals) sparse matrices. Also controls whether the mass matrix is sparse, wherever applicable. $(prob_fun_common_kwargs(func, istd)) $(process_optional_function_kwargs(optionals)) + - `kwargs...`: Additional keyword arguments passed to the solver All other keyword arguments are forwarded to the `$func` struct constructor. """