Skip to content

Commit

Permalink
add deprecate file
Browse files Browse the repository at this point in the history
  • Loading branch information
ytdHuang committed Oct 25, 2024
1 parent 3357706 commit ed74002
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/QuantumToolbox.jl
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,7 @@ include("metrics.jl")
include("negativity.jl")
include("steadystate.jl")

# deprecated functions
include("deprecated.jl")

end
15 changes: 15 additions & 0 deletions src/deprecated.jl
Original file line number Diff line number Diff line change
@@ -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
=#

0 comments on commit ed74002

Please sign in to comment.