Skip to content

Commit 583510d

Browse files
committed
Preserve old AutoTapir docstring
1 parent c57eb48 commit 583510d

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

docs/src/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ AutoGTPSA
4242
AutoMooncake
4343
AutoReverseDiff
4444
AutoTracker
45-
AutoTapir
4645
AutoZygote
4746
```
4847

@@ -107,3 +106,9 @@ ADTypes.SymbolicMode
107106
```@docs
108107
ADTypes.Auto
109108
```
109+
110+
## Deprecated
111+
112+
```@docs
113+
AutoTapir
114+
```

src/dense.jl

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,18 @@ mode(::AutoSymbolics) = SymbolicMode()
347347
!!! danger
348348
349349
`AutoTapir` is deprecated following a package renaming, please use [`AutoMooncake`](@ref) instead.
350+
351+
Struct used to select the [Tapir.jl](https://github.com/compintell/Tapir.jl) backend for automatic differentiation.
352+
353+
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
354+
355+
# Constructors
356+
357+
AutoTapir(; safe_mode=true)
358+
359+
# Fields
360+
361+
- `safe_mode::Bool`: whether to run additional checks to catch errors early.
350362
"""
351363
struct AutoTapir <: AbstractADType
352364
safe_mode::Bool

0 commit comments

Comments
 (0)