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

Documentation of the fields in the problem types #152

Open
ChrisRackauckas opened this issue Apr 26, 2022 · 0 comments
Open

Documentation of the fields in the problem types #152

ChrisRackauckas opened this issue Apr 26, 2022 · 0 comments
Labels
good first issue Good for newcomers

Comments

@ChrisRackauckas
Copy link
Member

#151 added a bunch of documentation for the problem types, but took some shortcuts when doing the fields. The only one that did it properly was the ODEProblem:

struct ODEProblem{uType,tType,isinplace,P,F,K,PT} <:
AbstractODEProblem{uType,tType,isinplace}
"""The ODE is `du = f(u,p,t)` for out-of-place and f(du,u,p,t) for in-place."""
f::F
"""The initial condition is `u(tspan[1]) = u0`."""
u0::uType
"""The solution `u(t)` will be computed for `tspan[1] ≤ t ≤ tspan[2]`."""
tspan::tType
"""Constant parameters to be supplied as the second argument of `f`."""
p::P
"""A callback to be applied to every solver which uses the problem."""
kwargs::K
problem_type::PT
"""An internal argument for storing traits about the solving process."""

All of the others didn't do it via docstrings on the fields. We should get that fixed, it's a nice first issue since it's quite cookie-cutter fix!

@ChrisRackauckas ChrisRackauckas added the good first issue Good for newcomers label Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant