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

Improve docstring for AutoTapir #68

Merged
merged 2 commits into from
Jul 1, 2024

Conversation

willtebbutt
Copy link
Contributor

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

@yebai pointed out to me that safe_mode might be better called debug_mode -- he feels (and I agree) that "safe mode" sounds like something you want to have on, while "debug mode" sounds like something you only want to have on when a problem arises.

Unfortunately we've effectively committed to safe_mode already in this package -- in order to properly change over to debug_mode we'd have to rename the safe_mode field of the AutoTapir type. This would be a breaking change, so it's not something that we can do right now.

Instead, I've improved the docstring to provide a bit more context, and make it a bit clearer what the purpose of the mode is.

@gdalle gdalle merged commit d41670e into SciML:main Jul 1, 2024
4 checks passed
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