From 0bb1bc180649331964aaf6f0878dcfae52f1e054 Mon Sep 17 00:00:00 2001 From: Jan Weidner Date: Thu, 20 Feb 2020 12:50:07 +0100 Subject: [PATCH] add warning to README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 24e6e37..8197aa4 100644 --- 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.