Merge pull request #16 from PowerShell/yutingc-patch-1

Update cmdlet names and parameters in rule documentation

Author: yutingc

RuleDocumentation/AvoidAlias.md

@@ -12,6 +12,6 @@ Please consider using full cmdlet name instead of alias.
 
 ##Example
 
-Wrong： gps | where-object {$_.WorkingSet -gt 20000000}
+Wrong： gps | Where-Object {$_.WorkingSet -gt 20000000}
 
-Correct: get-process | where-object {$_.WorkingSet -gt 20000000}
+Correct: Get-Process | Where-Object {$_.WorkingSet -gt 20000000}

RuleDocumentation/AvoidDefaultTrueValueSwitchParameter.md

@@ -19,7 +19,7 @@ Wrong：
     (      …
         $Param1,
         [switch]
-        $switch=$true
+        $Switch=$True
     )
 
 Correct:    
@@ -28,5 +28,5 @@ Correct:
     (      …
         $Param1,
         [switch]
-        $switch=$false
+        $Switch=$False
     )

RuleDocumentation/AvoidGlobalVars.md

@@ -15,13 +15,13 @@ Wrong:
 	$Global:var1 = $null
 	function NotGlobal ($var)
 	{
-    	$a = $var + $var1
+    		$a = $var + $var1
 	}
 
 Correct:
 
 	$Global:var1 = $null
-	function NotGlobal ($var1,$var2)
+	function NotGlobal ($var1, $var2)
 	{
-    	$a = $var1 + $var2
+    		$a = $var1 + $var2
 	}

RuleDocumentation/AvoidReservedCharInCmdlet.md

@@ -16,10 +16,10 @@ To fix a violation of this rule, please remove reserved characters from your adv
 
 Wrong： 
 
-function test[1]
+function Test[1]
 {...}
 
 Correct:
 
-function test
-{...}
+function Test
+{...}

RuleDocumentation/AvoidReservedParams.md

@@ -13,17 +13,19 @@ To fix a violation of this rule, please change the name of your parameter.
 ##Example
 
 Wrong： 
-
-function test
+```
+function Test
 {
     [CmdletBinding]
     Param($ErrorVariable, $b)
 }
+```
 
 Correct:
-
-function test
+```
+function Test
 {
     [CmdletBinding]
     Param($err, $b)
 }
+```

RuleDocumentation/AvoidShouldContinueWithoutForce.md

@@ -21,7 +21,7 @@ Wrong:
 	                  HelpUri = 'http://www.microsoft.com/',
 	                  ConfirmImpact='Medium')]
 	    [Alias()]
-	    [OutputType([String])]
+	    [OutputType([string])]
 	    Param
 	    (
 	        # Param1 help description
@@ -50,7 +50,7 @@ Wrong:
 	        [Parameter(ParameterSetName='Another Parameter Set')]
 	        [ValidatePattern("[a-z]*")]
 	        [ValidateLength(0,15)]
-	        [String]
+	        [string]
 	        $Param3
 	    )
 
@@ -79,7 +79,7 @@ Correct:
 	                  HelpUri = 'http://www.microsoft.com/',
 	                  ConfirmImpact='Medium')]
 	    [Alias()]
-	    [OutputType([String])]
+	    [OutputType([string])]
 	    Param
 	    (
 	        # Param1 help description
@@ -110,7 +110,7 @@ Correct:
 	        [Parameter(ParameterSetName='Another Parameter Set')]
 	        [ValidatePattern("[a-z]*")]
 	        [ValidateLength(0,15)]
-	        [String]
+	        [string]
 	        $Param3,
 	        [bool]
 	        $Force

RuleDocumentation/AvoidTrapStatement.md

@@ -13,20 +13,20 @@ To fix a violation of this rule, please remove Trap statements and use try-catch
 ##Example
 
 Wrong：    
-
+```
     function TrapTest 
     {
     	trap {"Error found: $_"}
 	}
-
+```
 Correct:    
-
+```
     function TrapTest 
     {
     	try 
     	{
             $a = New-Object "dafdf"
-            $a | get-member
+            $a | Get-Member
         }
     	catch [System.Exception]
     	{
@@ -36,4 +36,5 @@ Correct:
     	{
             "End the script"
     	}
-	}
+     }
+ ```

RuleDocumentation/AvoidUsingInvokeExpression.md

@@ -15,8 +15,8 @@ To fix a violation of this rule, please remove Invoke-Expression from script and
 
 Wrong： 
 
-	Invoke-Expression "get-process"
+	Invoke-Expression "Get-Process"
 
 Correct: 
 
-	Get-process
+	Get-Process

RuleDocumentation/AvoidUsingPlainTextForPassword.md

@@ -13,7 +13,7 @@ To fix a violation of this rule, please use SecurityString as the type of passwo
 ##Example
 
 Wrong： 
-
+```
     function Verb-Noun
     {
         [CmdletBinding()]
@@ -29,28 +29,29 @@ Wrong：
             # Param2 help description
             [int]
             $Param2,
-            [securestring]
+            [SecureString]
             $Password,
             [System.Security.SecureString]
-            $pass,
-            [securestring[]]
-            $passwords,
-            $passphrases,
-            $passwordparam
+            $Pass,
+            [SecureString[]]
+            $Passwords,
+            $Passphrases,
+            $Passwordparam
         )
     }
 
-    function TestFunction($password, [System.Security.SecureString[]]passphrases, [string]$passThru){
+    function TestFunction($password, [System.Security.SecureString[]]passphrases, [String]$passThru){
     }
-
+```
 
 Correct: 
 
+```
 	function Test-Script
 	{
 	    [CmdletBinding()]
 	    [Alias()]
-	    [OutputType([int])]
+	    [OutputType([Int])]
 	    Param
 	    (
 	        # Param1 help description
@@ -61,21 +62,22 @@ Correct:
 	        # Param2 help description
 	        [int]
 	        $Param2,
-	        [securestring]
+	        [SecureString]
 	        $Password,
 	        [System.Security.SecureString]
-	        $pass,
-		    [securestring[]]
-	        $passwords,
-	        [securestring]
-    		$passphrases,
-    	    [securestring]
-    		$passwordparam,
-    	    [string]
-    	    $PassThru
+	        $Pass,
+		[SecureString[]]
+	        $Passwords,
+	        [SecureString]
+    		$Passphrases,
+    	    	[SecureString]
+    		$PasswordParam,
+    	    	[string]
+    	    	$PassThru
     	    )
     	    ...
 	}
 
-	function TestFunction([securestring]$password, [System.Security.SecureString[]]$passphrases, [securestring[]]$passes){
-	}
+	function TestFunction([SecureString]$Password, [System.Security.SecureString[]]$Passphrases, [SecureString[]]$passes){
+	}
+```

RuleDocumentation/AvoidUsingUsernameAndPasswordParams

@@ -13,16 +13,18 @@ To fix a violation of this rule, please pass username and password as a PSCreden
 ##Example
 
 Wrong：    
-
-	[int]
+```
+    [int]
     $Param2,
-    [securestring]
+    [SecureString]
     $Password,
     [string]
-    $username
+    $Username
+```
 
 Correct:   
-
-	function MyFunction3 ([PSCredential]$username, $passwords)
-	{
-	}
+```
+    function MyFunction3 ([PSCredential]$Username, $Passwords)
+    {
+    }
+```

RuleDocumentation/AvoidUsingUsernameAndPasswordParams.md

@@ -23,7 +23,7 @@ Wrong:
                       HelpUri = 'http://www.microsoft.com/',
                       ConfirmImpact='Medium')]
         [Alias()]
-        [OutputType([String])]
+        [OutputType([string])]
         Param
         (
             ...
@@ -63,9 +63,9 @@ Right:
                       HelpUri = 'http://www.microsoft.com/',
                       ConfirmImpact='Medium')]
         [Alias()]
-        [OutputType([String])]
+        [OutputType([string])]
         Param
         (
             ...
         )
-    }
+    }

RuleDocumentation/ProvideCommentHelp.md

@@ -11,4 +11,20 @@ Checks that Write-Verbose is called at least once in every cmdlet or script. Thi
 Please consider adding Write-Verbose in each cmdlet.
 
 ##Example
+Correct
+```
+Function TestFunction1
+{
+    [cmdletbinding()]
+    Param()
+    Write-Verbose "Verbose output"
 
+}
+
+Function TestFunction2
+{
+    [cmdletbinding()]
+    Param(）
+    Write-Verbose "Verbose output"
+}
+```

RuleDocumentation/ProvideVerboseMessage.md

@@ -14,9 +14,9 @@ To fix a violation of this rule, please use mandatory parameters when calling cm
 
 Wrong： 
 
-	set-date
+	Set-Date
 
 Correct: 
 
-	$t = get-date
-	set-date -date $t
+	$date = Get-Date
+	Set-Date -Date $t

RuleDocumentation/UseCmdletCorrectly.md

@@ -14,14 +14,14 @@ Please change the parameter type to be PSCredential.
 
 Wrong:
 
-	function Credential([string]$credential) 
+	function Credential([String]$Credential) 
 	{
 		...
 	}
 
 Correct:
 
-	function Credential([PSCredential]$credential) 
+	function Credential([PSCredential]$Credential) 
 	{
 		...
-	}
+	}