Skip to content
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.

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

algo keywords #629

Open
ArnoStrouwen opened this issue Dec 21, 2022 · 1 comment
Open

algo keywords #629

ArnoStrouwen opened this issue Dec 21, 2022 · 1 comment

Comments

@ArnoStrouwen
Copy link
Member

It is a bit annoying that the algo keywords are not present in the docs, e.g
https://docs.sciml.ai/DiffEqDocs/stable/solvers/ode_solve/#Explicit-Runge-Kutta-Methods

Tsit5 - Tsitouras 5/4 Runge-Kutta method. (free 4th order interpolant).

Does not say anything about stage_limiter!

  Tsit5(; stage_limiter! = OrdinaryDiffEq.trivial_limiter!,
          step_limiter! = OrdinaryDiffEq.trivial_limiter!,
          thread = OrdinaryDiffEq.False())

Should all these docstrings be added?
If so, probably best in a collapsed by default part since otherwise the page would become very long.

@ChrisRackauckas
Copy link
Member

They should all get added. It will just take a ton of time. This is why separate OrdinaryDiffEq.jl docs were created to start testing this, and a separate section of the DiffEqDocs were made for detailed solver APIs: https://docs.sciml.ai/DiffEqDocs/dev/api/sundials/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants