Add is_unconstrained docs

noir-lang · Jul 5, 2024 · 4285c10 · 4285c10
1 parent b4eed93
commit 4285c10
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/docs/docs/noir/standard_library/is_unconstrained.md b/docs/docs/noir/standard_library/is_unconstrained.md
@@ -56,4 +56,14 @@ pub fn external_interface(){
 
 ```
 
-The is_unconstrained result is resolved at compile time, so in unconstrained contexts the compiler removes the else branch, and in constrained contexts the compiler removes the if branch, reducing the amount of compute necessary to run external_interface.
+The is_unconstrained result is resolved at compile time, so in unconstrained contexts the compiler removes the else branch, and in constrained contexts the compiler removes the if branch, reducing the amount of compute necessary to run external_interface.
+
+Note that using `is_unconstrained` in a `comptime` context will also return `true`:
+
+```
+fn main() {
+    comptime {
+        assert(is_unconstrained());
+    }
+}
+```