Improve phpdoc about validUnusedVariableNames

sirbrillig · Apr 20, 2018 · 45e0466 · 45e0466
1 parent 969a452
commit 45e0466
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php b/VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php
@@ -41,8 +41,9 @@ class VariableAnalysisSniff implements Sniff {
   public $allowUnusedFunctionParameters = false;
 
   /**
-   *  A list of names of placeholder variables that you want to ignore from
-   *  unused variable warnings, ie things like $junk.
+   *  A space-separated list of names of placeholder variables that you want to
+   *  ignore from unused variable warnings. For example, to ignore the variables
+   *  `$junk` and `$unused`, this could be set to `'junk unused'`.
    */
   public $validUnusedVariableNames = null;