add warning to README.md

jw3126 · Feb 20, 2020 · 0bb1bc1 · 0bb1bc1
1 parent 380c60c
commit 0bb1bc1
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -38,5 +38,7 @@ using OptionalArgChecks # this also reexports ArgCheck.jl for convenience
 
 f(x) = @argcheck x > 0
 
-@unsafe_skipargcheck f(-1) # see OptionalArgChecks docs for why this is called unsafe
+@unsafe_skipargcheck f(-1)
 ```
+This feature is currently experimental. It may be silently changed or removed without increasing the major ArgCheck version number.
+See the OptionalArgChecks documentation for some of the caveats.