SciML / ADTypes.jl

Repository for automatic differentiation backend types
https://sciml.github.io/ADTypes.jl/
MIT License
36 stars 11 forks source link

Improve docstring for AutoTapir #68

Closed willtebbutt closed 3 weeks ago

willtebbutt commented 3 weeks ago

Checklist

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.