From ed7400262992a0674a8ec08af63e8af757d91f15 Mon Sep 17 00:00:00 2001 From: Yi-Te Huang Date: Fri, 25 Oct 2024 11:35:39 +0900 Subject: [PATCH] add deprecate file --- src/QuantumToolbox.jl | 3 +++ src/deprecated.jl | 15 +++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 src/deprecated.jl diff --git a/src/QuantumToolbox.jl b/src/QuantumToolbox.jl index 549df5b01..a589600a4 100644 --- a/src/QuantumToolbox.jl +++ b/src/QuantumToolbox.jl @@ -102,4 +102,7 @@ include("metrics.jl") include("negativity.jl") include("steadystate.jl") +# deprecated functions +include("deprecated.jl") + end diff --git a/src/deprecated.jl b/src/deprecated.jl new file mode 100644 index 000000000..8cc4db3e5 --- /dev/null +++ b/src/deprecated.jl @@ -0,0 +1,15 @@ +#= +This file gathers all the deprecated names (structures, functions, or variables) which will be removed in the future major release. + +- Before the major release, the deprecated names will just throw errors when they are called. +- If the deprecated names were once exported, we will still export them here until next major release. +- If we decide to push a major release, cleanup this file. + +Example: + +export deprecated_foo + +function deprecated_foo(args...; kwargs...) + error("`deprecated_foo` has been deprecated and will be removed in next major release, please use `new_foo` instead.") +end +=#