Add note to use-const rule

bbannier · Dec 4, 2023 · a073220 · a073220
1 parent 4d36b0e
commit a073220
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/rules/use-const.yml b/rules/use-const.yml
@@ -17,3 +17,11 @@ rule:
             kind: "integer"
 
 fix: "const"
+
+note: |
+  'const' variables can potentially be optimized better than 'global'
+  variables, e.g., they could be inlined while access to a 'global' is always
+  through an indirection.
+
+  This role does not validate whether the 'global' is modified elsewhere so it
+  can have FALSE POSITIVES.