From c57eb48993ae8a52d967480e649b59ddd838761a Mon Sep 17 00:00:00 2001 From: Guillaume Dalle <22795598+gdalle@users.noreply.github.com> Date: Wed, 25 Sep 2024 13:27:11 +0200 Subject: [PATCH] Apply suggestions from code review --- src/dense.jl | 11 +++++------ src/legacy.jl | 2 +- test/legacy.jl | 1 + 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/dense.jl b/src/dense.jl index f9f1383..7a1ee0b 100644 --- a/src/dense.jl +++ b/src/dense.jl @@ -230,8 +230,7 @@ end """ AutoMooncake -Struct used to select the [Mooncake.jl](https://github.com/compintell/Mooncake.jl) backend -for automatic differentiation. +Struct used to select the [Mooncake.jl](https://github.com/compintell/Mooncake.jl) backend for automatic differentiation. Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl). @@ -241,9 +240,7 @@ Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl). # Fields - - `config`: either `nothing` or an instance of `Mooncake.Config` -- see the docstring for - `Mooncake.Config` for more information. `AutoMooncake(; config=nothing)` is equivalent - to `AutoMooncake(; config=Mooncake.Config())`, i.e. the default configuration. + - `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. """ Base.@kwdef struct AutoMooncake{Tconfig} <: AbstractADType config::Tconfig @@ -347,7 +344,9 @@ mode(::AutoSymbolics) = SymbolicMode() """ AutoTapir -This ADType is deprecated. `AutoMooncake` should be used instead. +!!! danger + + `AutoTapir` is deprecated following a package renaming, please use [`AutoMooncake`](@ref) instead. """ struct AutoTapir <: AbstractADType safe_mode::Bool diff --git a/src/legacy.jl b/src/legacy.jl index d9dd942..93db34f 100644 --- a/src/legacy.jl +++ b/src/legacy.jl @@ -39,7 +39,7 @@ end function AutoTapir(; safe_mode=true) Base.depwarn( - "AutoTapir is deprecated in favour of AutoMooncake.", :AutoTapir; force=false + "`AutoTapir` is deprecated in favour of `AutoMooncake`.", :AutoTapir; force=false ) return AutoTapir(safe_mode) end diff --git a/test/legacy.jl b/test/legacy.jl index 4db993b..8f20b69 100644 --- a/test/legacy.jl +++ b/test/legacy.jl @@ -71,4 +71,5 @@ end @testset "AutoTapir" begin @test_deprecated AutoTapir() + @test_deprecated AutoTapir(; safe_mode=false) end