Skip to content

Commit a12817f

Browse files
ytdHuangalbertomercurio
authored andcommitted
add deprecate file (qutip#274)
1 parent ca720cb commit a12817f

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

src/QuantumToolbox.jl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,7 @@ include("metrics.jl")
102102
include("negativity.jl")
103103
include("steadystate.jl")
104104

105+
# deprecated functions
106+
include("deprecated.jl")
107+
105108
end

src/deprecated.jl

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#=
2+
This file gathers all the deprecated names (structures, functions, or variables) which will be removed in the future major release.
3+
4+
- Before the major release, the deprecated names will just throw errors when they are called.
5+
- If the deprecated names were once exported, we will still export them here until next major release.
6+
- If we decide to push a major release, cleanup this file.
7+
8+
Example:
9+
10+
export deprecated_foo
11+
12+
function deprecated_foo(args...; kwargs...)
13+
error("`deprecated_foo` has been deprecated and will be removed in next major release, please use `new_foo` instead.")
14+
end
15+
=#

0 commit comments

Comments
 (0)