From ed8f4cb6a0817d13bcdc1a415b067befdbd90299 Mon Sep 17 00:00:00 2001
From: ringabout <43030857+ringabout@users.noreply.github.com>
Date: Fri, 15 Dec 2023 21:50:38 +0800
Subject: [PATCH] fixes #18073; fixes #14730; document notnil is only applied
 to local symbols

fixes #18073
fixes #14730
---
 doc/manual_experimental.md | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/doc/manual_experimental.md b/doc/manual_experimental.md
index f5e39b768bc01..3b552ef8e571f 100644
--- a/doc/manual_experimental.md
+++ b/doc/manual_experimental.md
@@ -560,7 +560,8 @@ Not nil annotation
 `{.experimental: "notnil".}`.
 
 All types for which `nil` is a valid value can be annotated with the
-`not nil` annotation to exclude `nil` as a valid value:
+`not nil` annotation to exclude `nil` as a valid value. Note that only local
+symbols are checked.
 
   ```nim
   {.experimental: "notnil".}
@@ -577,8 +578,11 @@ All types for which `nil` is a valid value can be annotated with the
   p(nil)
 
   # and also this:
-  var x: PObject
-  p(x)
+  proc foo =
+    var x: PObject
+    p(x)
+
+  foo()
   ```
 
 The compiler ensures that every code path initializes variables which contain