Add deprecation notice to docs on SnoopPrecompile (#363)

timholy · Apr 28, 2023 · df2d507 · df2d507 · timholy · Apr 28, 2023
1 parent 0d84aed
commit df2d507
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "SnoopCompile"
 uuid = "aa65fe97-06da-5843-b5b1-d5d13cad87d2"
 author = ["Tim Holy <tim.holy@gmail.com>"]
-version = "2.10.6"
+version = "2.10.7"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

diff --git a/docs/src/snoop_pc.md b/docs/src/snoop_pc.md
@@ -1,5 +1,8 @@
 # SnoopPrecompile
 
+!!! warning
+    SnoopPrecompile is deprecated. Please use [PrecompileTools](https://github.com/JuliaLang/PrecompileTools.jl) instead.
+
 SnoopPrecompile provides a macro, `@precompile_all_calls`, which precompiles every call on its first usage.
 The key feature of `@precompile_all_calls` is that it intercepts all callees (including those made by runtime dispatch) and, on Julia 1.8 and higher, allows you to precompile the callee even if it comes from a different module (e.g., `Base` or a different package).