aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPavel Janík <Pavel@Janik.cz>2017-05-10 19:48:24 +0200
committerPavel Janík <Pavel@Janik.cz>2017-05-10 19:48:24 +0200
commitf203ecc621c0af594c43c7fce8a765a8259e3b43 (patch)
treef7bd88dc933df932680562475ce57fc5a5cab781 /doc
parenta26280bc14158b6972297e06418c9ee1c5653743 (diff)
Shadowing is not enabled by default, update doc accordingly.
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-notes.md7
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index fd75ada79f..cf860a1bf2 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -343,10 +343,9 @@ Strings and formatting
Variable names
--------------
-The shadowing warning (`-Wshadow`) is enabled by default. It prevents issues rising
-from using a different variable with the same name.
-
-Please name variables so that their names do not shadow variables defined in the source code.
+Although the shadowing warning (`-Wshadow`) is not enabled by default (it prevents issues rising
+from using a different variable with the same name),
+please name variables so that their names do not shadow variables defined in the source code.
E.g. in member initializers, prepend `_` to the argument name shadowing the
member name: