From 12ff1c270210965abb741ae16da8cfcfeb061eb2 Mon Sep 17 00:00:00 2001
From: Alexander Medvednikov <alexander@vlang.io>
Date: Sun, 24 Jan 2021 10:23:52 +0100
Subject: [PATCH] doc: document the new const rule

---
 doc/docs.md                                  | 15 +++++++++++----
 vlib/v/checker/tests/var_duplicate_const.out |  7 -------
 2 files changed, 11 insertions(+), 11 deletions(-)
 delete mode 100644 vlib/v/checker/tests/var_duplicate_const.out

diff --git a/doc/docs.md b/doc/docs.md
index ef88fb6cfd..9d00d9828d 100644
--- a/doc/docs.md
+++ b/doc/docs.md
@@ -1716,15 +1716,22 @@ const (
 	blue    = rgb(0, 0, 255)
 )
 
-println(numbers)
-println(red)
-println(blue)
+println(main.numbers)
+println(main.red)
+println(main.blue)
 ```
 
 Global variables are not allowed, so this can be really useful.
 
+When naming constants, `snake_case` must be used. In order to distinguish consts
+from local variables, the full path to consts must be specified. For example,
+to access the PI const, full `math.pi` name must be used both outside the `math` module,
+and inside it. This can be seen in the example above with `println(main.numbers)`.
+
+vfmt takes care of this rule, so you can type `println(pi)` inside the `math` module,
+and vffmt will automatically update it to `println(math.pi)`.
+
 <!--
-When naming constants, snake_case must be used.
 Many people prefer all caps consts: `TOP_CITIES`. This wouldn't work
 well in V, because consts are a lot more powerful than in other languages.
 They can represent complex structures, and this is used quite often since there
diff --git a/vlib/v/checker/tests/var_duplicate_const.out b/vlib/v/checker/tests/var_duplicate_const.out
deleted file mode 100644
index 42f178d6c4..0000000000
--- a/vlib/v/checker/tests/var_duplicate_const.out
+++ /dev/null
@@ -1,7 +0,0 @@
-vlib/v/checker/tests/var_duplicate_const.vv:8:2: error: duplicate of a const name `age`
-    6 |
-    7 | fn main() {
-    8 |     age := 30
-      |     ~~~
-    9 |     println(age)
-   10 | }