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

Added documentation for methods ROS2, ROS3, ROS2PR, ROS2S, ROS3PR, Sc… #733

Merged
merged 2 commits into from
Apr 22, 2024

Conversation

cwittens
Copy link
Contributor

…holz47,ROS34PRw, ROS3PRL, ROS3PRL2

Checklist

  • Appropriate tests were added
  • Any code changes were done in a way that does not break public API
  • All documentation related to code changes were updated
  • The new code follows the
    contributor guidelines, in particular the SciML Style Guide and
    COLPRAC.
  • Any new documentation only uses public API

Additional context

added documentation for the methods added in SciML/OrdinaryDiffEq.jl#2113, SciML/OrdinaryDiffEq.jl#2126 and SciML/OrdinaryDiffEq.jl#2165

Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot! I guess we should wait until SciML/OrdinaryDiffEq.jl#2165 is merged before merging this

docs/src/solvers/ode_solve.md Outdated Show resolved Hide resolved
@cwittens
Copy link
Contributor Author

Maybe a question about the documentation in general. Does it make sense to put a hyperlink to the paper where the methods are discussed? Right now you can only find that link when looking up the documentation inside OrdinaryDiffEq using help, which seems counter intuitive to me.

@ranocha
Copy link
Member

ranocha commented Mar 31, 2024

I would be in favor of adding such links. Maybe we could just print the docstring of each algorithm here?

@ChrisRackauckas
Copy link
Member

They should go into the OrdinaryDiffEq docs (which should then get a section here when it's ready enough in the API section). This is supposed to just be a summary of available solvers, not a complete description of each one.

@cwittens
Copy link
Contributor Author

Thanks a lot! I guess we should wait until SciML/OrdinaryDiffEq.jl#2165 is merged before merging this

now that SciML/OrdinaryDiffEq.jl#2165 is merged, the documantation can be merged too? @ChrisRackauckas

@ChrisRackauckas ChrisRackauckas merged commit 8114391 into SciML:master Apr 22, 2024
1 of 3 checks passed
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

Successfully merging this pull request may close these issues.

3 participants