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

Update docs to use single-argument domain instead of two-argument lb, ub #228

Merged
merged 6 commits into from
Feb 11, 2024

Conversation

lxvm
Copy link
Collaborator

@lxvm lxvm commented Feb 11, 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

I wanted to update the documentation to use the one-argument form domain = (lb, ub) instead of the deprecated two-argument version. I also found a bug in the last README example due to a large maxiters default for the Cuba wrapper, so I replaced the defaults by the same ones as in Cuba.jl. I also added some deprecation warnings for lb, ub in the caching interface.

@ChrisRackauckas
Copy link
Member

Awesome, this'll definitely help a lot of folks. Sorry I hadn't gotten around to this.

@ChrisRackauckas ChrisRackauckas merged commit d260b54 into SciML:master Feb 11, 2024
7 of 8 checks passed
@lxvm lxvm deleted the docs branch February 11, 2024 14: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