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

[RFC] Better integral docs #609

Merged
merged 3 commits into from
Feb 10, 2024
Merged

Conversation

lxvm
Copy link
Contributor

@lxvm lxvm commented Feb 3, 2024

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

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

  • Restore the method to set inplace IntegralProblems for all integrands
  • Publish the IntegralFunction and BatchIntegralFunction docstrings to the web documentation
  • Improve the clarity of the IntegralFunction and BatchIntegralFunction docstrings

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.

Copy link

codecov bot commented Feb 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@             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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ChrisRackauckas ChrisRackauckas merged commit 1a148f4 into SciML:master Feb 10, 2024
34 of 41 checks passed
@lxvm lxvm deleted the integral-docs branch February 10, 2024 18:54
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.

2 participants