aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2017-05-11 07:17:10 +0200
committerWladimir J. van der Laan <laanwj@gmail.com>2017-05-11 07:18:18 +0200
commit7f2b9e0868f5759187e63df4f2cbd5f4fc9c81d7 (patch)
treef7bd88dc933df932680562475ce57fc5a5cab781
parenta26280bc14158b6972297e06418c9ee1c5653743 (diff)
parentf203ecc621c0af594c43c7fce8a765a8259e3b43 (diff)
Merge #10381: Shadowing warnings are not enabled by default, update doc accordingly
f203ecc Shadowing is not enabled by default, update doc accordingly. (Pavel Janík) Tree-SHA512: a7170827caa9d35457356808445ef2387fd2edde72fb76c6241cfd5decad218558b307d223e86bb66041576b638f90f6efa8a46ea6208d43da275a993617c997
-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: