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

Extended algorithm documentation in constituent packages #120

Closed
ChrisRackauckas opened this issue Dec 19, 2016 · 1 comment
Closed

Extended algorithm documentation in constituent packages #120

ChrisRackauckas opened this issue Dec 19, 2016 · 1 comment

Comments

@ChrisRackauckas
Copy link
Member

There is much algorithm-specific information:

  • What parts of the common interface are supported by each solver
  • Extended information on the extra options each has available
  • The documentation for their specific callbacks
  • The types that the algorithm supports

I think we should follow JuliaOpt's lead and have this be documentation which is part of the solver packages themselves. So DifferentialEquations.jl would have a general overview of the packages which are available and help guide users to choices (like it is now), but each section would contain a link to the package's own documentation detailed information about all of the extra stuff (like the JuMP) documentation. This will allow all of the details to be documented without bloating the main docs.

@ChrisRackauckas
Copy link
Member Author

Most of this was done by making stuff act more uniformly, and they all have READMEs now.

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

No branches or pull requests

1 participant