Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #168 . As discussed in SciML/ADTypes.jl#68,
safe_mode
is part of the public interface ofADTypes
as it is a documented field of theAutoTapir
type. This means that we cannot change it without making a breaking change toADTypes
. Since we can't do this, it seems preferable to simply clarify the nature of safe mode / thesafety_on
kwarg, then to rename it and have multiple names floating around.The purpose of this PR, therefore, is to improve the documentation around safe_mode / safety_on, to ensure that users are aware of what it does.