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

Document kwargs and fix missing uses #199

Open
gdalle opened this issue Feb 10, 2025 · 3 comments
Open

Document kwargs and fix missing uses #199

gdalle opened this issue Feb 10, 2025 · 3 comments

Comments

@gdalle
Copy link
Member

gdalle commented Feb 10, 2025

The kwargs absstep, relstep and dir are not uniformly documented. And there might even be cases where one kwarg is forgotten, i.e. here (dir is missing). Now that DI has to use them, it would be nice if someone could explain what they do and check that they are properly passed around?

@ChrisRackauckas
Copy link
Member

absstep and relstep are absolute and relative stepsize changes requested by the user, and dir is what direction to differentiate (i.e. what direction is "forward")

@gdalle
Copy link
Member Author

gdalle commented Feb 10, 2025

is it voluntary that some functions don't use some of these kwargs, like the one I pointed to?

@oscardssmith
Copy link
Member

I think that is probably unintentional (or at least not fully intentonal). IIUC, dir was basically hacked in by SciML to prevent calling a function out of domain so it possibly only has made it to the APIs that SciML cares about.

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

No branches or pull requests

3 participants