Skip to content

Commit c57eb48

Browse files
authored
Apply suggestions from code review
1 parent 855a21b commit c57eb48

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

src/dense.jl

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,7 @@ end
230230
"""
231231
AutoMooncake
232232
233-
Struct used to select the [Mooncake.jl](https://github.com/compintell/Mooncake.jl) backend
234-
for automatic differentiation.
233+
Struct used to select the [Mooncake.jl](https://github.com/compintell/Mooncake.jl) backend for automatic differentiation.
235234
236235
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
237236
@@ -241,9 +240,7 @@ Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
241240
242241
# Fields
243242
244-
- `config`: either `nothing` or an instance of `Mooncake.Config` -- see the docstring for
245-
`Mooncake.Config` for more information. `AutoMooncake(; config=nothing)` is equivalent
246-
to `AutoMooncake(; config=Mooncake.Config())`, i.e. the default configuration.
243+
- `config`: either `nothing` or an instance of `Mooncake.Config` -- see the docstring of `Mooncake.Config` for more information. `AutoMooncake(; config=nothing)` is equivalent to `AutoMooncake(; config=Mooncake.Config())`, i.e. the default configuration.
247244
"""
248245
Base.@kwdef struct AutoMooncake{Tconfig} <: AbstractADType
249246
config::Tconfig
@@ -347,7 +344,9 @@ mode(::AutoSymbolics) = SymbolicMode()
347344
"""
348345
AutoTapir
349346
350-
This ADType is deprecated. `AutoMooncake` should be used instead.
347+
!!! danger
348+
349+
`AutoTapir` is deprecated following a package renaming, please use [`AutoMooncake`](@ref) instead.
351350
"""
352351
struct AutoTapir <: AbstractADType
353352
safe_mode::Bool

src/legacy.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ end
3939

4040
function AutoTapir(; safe_mode=true)
4141
Base.depwarn(
42-
"AutoTapir is deprecated in favour of AutoMooncake.", :AutoTapir; force=false
42+
"`AutoTapir` is deprecated in favour of `AutoMooncake`.", :AutoTapir; force=false
4343
)
4444
return AutoTapir(safe_mode)
4545
end

test/legacy.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,5 @@ end
7171

7272
@testset "AutoTapir" begin
7373
@test_deprecated AutoTapir()
74+
@test_deprecated AutoTapir(; safe_mode=false)
7475
end

0 commit comments

Comments
 (0)