Added back prob and logprob macros (#609)

* added back prob and logprob macros * added refernece to issue discussing removal * added tests so we remeber they're there * export for compat and make errors runtime rather than parsetime * Update src/DynamicPPL.jl
TuringLang · May 17, 2024 · 0d4962e · 0d4962e · torfjelde · May 17, 2024
1 parent 278a82a
commit 0d4962e
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/src/DynamicPPL.jl b/src/DynamicPPL.jl
@@ -129,12 +129,28 @@ export AbstractVarInfo,
     @submodel,
     value_iterator_from_chain,
     check_model,
-    check_model_and_trace
+    check_model_and_trace,
+    # Deprecated.
+    @logprob_str,
+    @prob_str
 
 # Reexport
 using Distributions: loglikelihood
 export loglikelihood
 
+# TODO: Remove once we feel comfortable people aren't using it anymore.
+macro logprob_str(str)
+    return :(error(
+        "The `@logprob_str` macro is no longer supported. See https://turinglang.org/dev/docs/using-turing/guide/#querying-probabilities-from-model-or-chain for information on how to query probabilities, and https://github.com/TuringLang/DynamicPPL.jl/issues/356 for information regarding its removal.",
+    ))
+end
+
+macro prob_str(str)
+    return :(error(
+        "The `@prob_str` macro is no longer supported. See https://turinglang.org/dev/docs/using-turing/guide/#querying-probabilities-from-model-or-chain for information on how to query probabilities, and https://github.com/TuringLang/DynamicPPL.jl/issues/356 for information regarding its removal.",
+    ))
+end
+
 # Used here and overloaded in Turing
 function getspace end
 

diff --git a/test/runtests.jl b/test/runtests.jl
@@ -71,6 +71,11 @@ include("test_util.jl")
             include("ad.jl")
         end
 
+        @testset "prob and logprob macro" begin
+            @test_throws ErrorException prob"..."
+            @test_throws ErrorException logprob"..."
+        end
+
         @testset "doctests" begin
             DocMeta.setdocmeta!(
                 DynamicPPL,