Skip to content

Add solver kwargs to prob docstrings #3861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 31, 2025
Merged

Add solver kwargs to prob docstrings #3861

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bbf4f4
Add solver docstring references to the problem docstring
ChrisRackauckas Jul 30, 2025
30234c6
Merge pull request #1 from ChrisRackauckas/ChrisRackauckas-patch-5
ChrisRackauckas Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/problems/docs.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
"""
Expand Down
Loading