SciML / SciMLBase.jl

The Base interface of the SciML ecosystem
https://docs.sciml.ai/SciMLBase/stable
MIT License
119 stars 91 forks source link

[RFC] Better integral docs #609

Closed lxvm closed 4 months ago

lxvm commented 5 months ago

Checklist

Additional context

The updates to IntegralProblems in SciML v2 lost the ability to set an in-place IntegralProblem for a non-IntegralFunction, observed here https://github.com/SciML/SciMLExpectations.jl/pull/148, and inadequate web documentation for the new interface, as in this issue https://github.com/SciML/Integrals.jl/issues/218 and a discourse post. I want to address the following in this pr

I would appreciate comments on my writing and how we should publish the docstrings. I will also open a pr to Integrals.jl to update the readme and documentation with examples of the new interface.

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (0c62711) 26.25% compared to head (26c20dc) 40.15%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #609 +/- ## =========================================== + Coverage 26.25% 40.15% +13.89% =========================================== Files 54 54 Lines 4113 4134 +21 =========================================== + Hits 1080 1660 +580 + Misses 3033 2474 -559 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.