Fix double-space added after 'Description' throughout module (#244)

Somehow two spaces got added after `'Description' =` in a function and then got copy/paste repeated throughout the module. This fixes that. It also adds a ruler line at the 100 character mark in VS Code to help developers see when they should start to wrap their code/comments.
microsoft · Jun 24, 2020 · 0bc09d2 · 0bc09d2
1 parent b70c7d4
commit 0bc09d2
Show file tree

Hide file tree

Showing 17 changed files with 59 additions and 55 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,4 +1,7 @@
 {
+    "editor.rulers": [
+        100
+    ],
     "[powershell]": {
         "files.trimTrailingWhitespace": true
     },

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -243,7 +243,8 @@ Here are some general guidelines
   reviewing/maintaining code.  There are of course exceptions, but this is generally an enforced
   preference.  The [Visual Studio Productivity Power Tools](https://visualstudiogallery.msdn.microsoft.com/34ebc6a2-2777-421d-8914-e29c1dfa7f5d)
   extension has a "Column Guides" feature that makes it easy to add a Guideline in column 100
-  to make it really obvious when coding.
+  to make it really obvious when coding.  If you use VS Code, this module's `.vscode/settings.json`
+  configures that for you automatically.
 
 ----------
 

diff --git a/GitHubAssignees.ps1 b/GitHubAssignees.ps1
@@ -100,7 +100,7 @@ filter Get-GitHubAssignee
 
     $params = @{
         'UriFragment' = "repos/$OwnerName/$RepositoryName/assignees"
-        'Description' =  "Getting assignee list for $RepositoryName"
+        'Description' = "Getting assignee list for $RepositoryName"
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'TelemetryProperties' = $telemetryProperties
@@ -228,7 +228,7 @@ filter Test-GitHubAssignee
     $params = @{
         'UriFragment' = "repos/$OwnerName/$RepositoryName/assignees/$Assignee"
         'Method' = 'Get'
-        'Description' =  "Checking permission for $Assignee for $RepositoryName"
+        'Description' = "Checking permission for $Assignee for $RepositoryName"
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'TelemetryProperties' = $telemetryProperties
@@ -411,7 +411,7 @@ function New-GitHubAssignee
             'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/assignees"
             'Body' = (ConvertTo-Json -InputObject $hashBody)
             'Method' = 'Post'
-            'Description' =  "Add assignees to issue $Issue for $RepositoryName"
+            'Description' = "Add assignees to issue $Issue for $RepositoryName"
             'AccessToken' = $AccessToken
             'AcceptHeader' = $script:symmetraAcceptHeader
             'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -603,7 +603,7 @@ function Remove-GitHubAssignee
                 'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/assignees"
                 'Body' = (ConvertTo-Json -InputObject $hashBody)
                 'Method' = 'Delete'
-                'Description' =  "Removing assignees from issue $Issue for $RepositoryName"
+                'Description' = "Removing assignees from issue $Issue for $RepositoryName"
                 'AccessToken' = $AccessToken
                 'AcceptHeader' = $script:symmetraAcceptHeader
                 'TelemetryEventName' = $MyInvocation.MyCommand.Name

diff --git a/GitHubBranches.ps1 b/GitHubBranches.ps1
@@ -144,7 +144,7 @@ filter Get-GitHubRepositoryBranch
 
     $params = @{
         'UriFragment' = $uriFragment + '?' + ($getParams -join '&')
-        'Description' =  "Getting branches for $RepositoryName"
+        'Description' = "Getting branches for $RepositoryName"
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'TelemetryProperties' = $telemetryProperties

diff --git a/GitHubIssueComments.ps1 b/GitHubIssueComments.ps1
@@ -413,7 +413,7 @@ filter New-GitHubIssueComment
         'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/comments"
         'Body' = (ConvertTo-Json -InputObject $hashBody)
         'Method' = 'Post'
-        'Description' =  "Creating comment under issue $Issue for $RepositoryName"
+        'Description' = "Creating comment under issue $Issue for $RepositoryName"
         'AccessToken' = $AccessToken
         'AcceptHeader' = (Get-MediaAcceptHeader -MediaType $MediaType -AsJson -AcceptHeader $squirrelGirlAcceptHeader)
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -556,7 +556,7 @@ filter Set-GitHubIssueComment
         'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/comments/$Comment"
         'Body' = (ConvertTo-Json -InputObject $hashBody)
         'Method' = 'Patch'
-        'Description' =  "Update comment $Comment for $RepositoryName"
+        'Description' = "Update comment $Comment for $RepositoryName"
         'AccessToken' = $AccessToken
         'AcceptHeader' = (Get-MediaAcceptHeader -MediaType $MediaType -AsJson -AcceptHeader $squirrelGirlAcceptHeader)
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -693,7 +693,7 @@ filter Remove-GitHubIssueComment
         $params = @{
             'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/comments/$Comment"
             'Method' = 'Delete'
-            'Description' =  "Removing comment $Comment for $RepositoryName"
+            'Description' = "Removing comment $Comment for $RepositoryName"
             'AccessToken' = $AccessToken
             'TelemetryEventName' = $MyInvocation.MyCommand.Name
             'TelemetryProperties' = $telemetryProperties

diff --git a/GitHubIssues.ps1 b/GitHubIssues.ps1
@@ -357,7 +357,7 @@ filter Get-GitHubIssue
 
     $params = @{
         'UriFragment' = $uriFragment + '?' +  ($getParams -join '&')
-        'Description' =  $description
+        'Description' = $description
         'AcceptHeader' = (Get-MediaAcceptHeader -MediaType $MediaType -AsJson -AcceptHeader $symmetraAcceptHeader)
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -484,7 +484,7 @@ filter Get-GitHubIssueTimeline
 
     $params = @{
         'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/timeline"
-        'Description' =  "Getting timeline for Issue #$Issue in $RepositoryName"
+        'Description' = "Getting timeline for Issue #$Issue in $RepositoryName"
         'AcceptHeader' = $script:mockingbirdAcceptHeader
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -643,7 +643,7 @@ filter New-GitHubIssue
         'UriFragment' = "/repos/$OwnerName/$RepositoryName/issues"
         'Body' = (ConvertTo-Json -InputObject $hashBody)
         'Method' = 'Post'
-        'Description' =  "Creating new Issue ""$Title"" on $RepositoryName"
+        'Description' = "Creating new Issue ""$Title"" on $RepositoryName"
         'AcceptHeader' = (Get-MediaAcceptHeader -MediaType $MediaType -AsJson -AcceptHeader $symmetraAcceptHeader)
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -823,7 +823,7 @@ filter Update-GitHubIssue
         'UriFragment' = "/repos/$OwnerName/$RepositoryName/issues/$Issue"
         'Body' = (ConvertTo-Json -InputObject $hashBody)
         'Method' = 'Patch'
-        'Description' =  "Updating Issue #$Issue on $RepositoryName"
+        'Description' = "Updating Issue #$Issue on $RepositoryName"
         'AcceptHeader' = (Get-MediaAcceptHeader -MediaType $MediaType -AsJson -AcceptHeader $symmetraAcceptHeader)
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -956,7 +956,7 @@ filter Lock-GitHubIssue
         'UriFragment' = "/repos/$OwnerName/$RepositoryName/issues/$Issue/lock"
         'Body' = (ConvertTo-Json -InputObject $hashBody)
         'Method' = 'Put'
-        'Description' =  "Locking Issue #$Issue on $RepositoryName"
+        'Description' = "Locking Issue #$Issue on $RepositoryName"
         'AcceptHeader' = $script:sailorVAcceptHeader
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -1066,7 +1066,7 @@ filter Unlock-GitHubIssue
     $params = @{
         'UriFragment' = "/repos/$OwnerName/$RepositoryName/issues/$Issue/lock"
         'Method' = 'Delete'
-        'Description' =  "Unlocking Issue #$Issue on $RepositoryName"
+        'Description' = "Unlocking Issue #$Issue on $RepositoryName"
         'AcceptHeader' = $script:sailorVAcceptHeader
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name

diff --git a/GitHubLabels.ps1 b/GitHubLabels.ps1
@@ -182,7 +182,7 @@ filter Get-GitHubLabel
 
     $params = @{
         'UriFragment' = $uriFragment
-        'Description' =  $description
+        'Description' = $description
         'AcceptHeader' = $script:symmetraAcceptHeader
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -327,7 +327,7 @@ filter New-GitHubLabel
         'UriFragment' = "repos/$OwnerName/$RepositoryName/labels"
         'Body' = (ConvertTo-Json -InputObject $hashBody)
         'Method' = 'Post'
-        'Description' =  "Creating label $Label in $RepositoryName"
+        'Description' = "Creating label $Label in $RepositoryName"
         'AcceptHeader' = $script:symmetraAcceptHeader
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -474,7 +474,7 @@ filter Remove-GitHubLabel
         $params = @{
             'UriFragment' = "repos/$OwnerName/$RepositoryName/labels/$Label"
             'Method' = 'Delete'
-            'Description' =  "Deleting label $Label from $RepositoryName"
+            'Description' = "Deleting label $Label from $RepositoryName"
             'AcceptHeader' = $script:symmetraAcceptHeader
             'AccessToken' = $AccessToken
             'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -626,7 +626,7 @@ filter Update-GitHubLabel
         'UriFragment' = "repos/$OwnerName/$RepositoryName/labels/$Label"
         'Body' = (ConvertTo-Json -InputObject $hashBody)
         'Method' = 'Patch'
-        'Description' =  "Updating label $Label"
+        'Description' = "Updating label $Label"
         'AcceptHeader' = $script:symmetraAcceptHeader
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -928,7 +928,7 @@ function Add-GitHubIssueLabel
             'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/labels"
             'Body' = (ConvertTo-Json -InputObject $hashBody)
             'Method' = 'Post'
-            'Description' =  "Adding labels to issue $Issue in $RepositoryName"
+            'Description' = "Adding labels to issue $Issue in $RepositoryName"
             'AcceptHeader' = $script:symmetraAcceptHeader
             'AccessToken' = $AccessToken
             'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -1117,7 +1117,7 @@ function Set-GitHubIssueLabel
             'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/labels"
             'Body' = (ConvertTo-Json -InputObject $hashBody)
             'Method' = 'Put'
-            'Description' =  "Replacing labels to issue $Issue in $RepositoryName"
+            'Description' = "Replacing labels to issue $Issue in $RepositoryName"
             'AcceptHeader' = $script:symmetraAcceptHeader
             'AccessToken' = $AccessToken
             'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -1275,7 +1275,7 @@ filter Remove-GitHubIssueLabel
         $params = @{
             'UriFragment' = "/repos/$OwnerName/$RepositoryName/issues/$Issue/labels/$Label"
             'Method' = 'Delete'
-            'Description' =  $description
+            'Description' = $description
             'AcceptHeader' = $script:symmetraAcceptHeader
             'AccessToken' = $AccessToken
             'TelemetryEventName' = $MyInvocation.MyCommand.Name

diff --git a/GitHubMilestones.ps1 b/GitHubMilestones.ps1
@@ -380,7 +380,7 @@ filter New-GitHubMilestone
         'UriFragment' = "repos/$OwnerName/$RepositoryName/milestones"
         'Body' = (ConvertTo-Json -InputObject $hashBody)
         'Method' = 'Post'
-        'Description' =  "Creating milestone for $RepositoryName"
+        'Description' = "Creating milestone for $RepositoryName"
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'TelemetryProperties' = $telemetryProperties
@@ -571,7 +571,7 @@ filter Set-GitHubMilestone
         'UriFragment' = "repos/$OwnerName/$RepositoryName/milestones/$Milestone"
         'Body' = (ConvertTo-Json -InputObject $hashBody)
         'Method' = 'Patch'
-        'Description' =  "Setting milestone $Milestone for $RepositoryName"
+        'Description' = "Setting milestone $Milestone for $RepositoryName"
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'TelemetryProperties' = $telemetryProperties
@@ -714,7 +714,7 @@ filter Remove-GitHubMilestone
         $params = @{
             'UriFragment' = "repos/$OwnerName/$RepositoryName/milestones/$Milestone"
             'Method' = 'Delete'
-            'Description' =  "Removing milestone $Milestone for $RepositoryName"
+            'Description' = "Removing milestone $Milestone for $RepositoryName"
             'AccessToken' = $AccessToken
             'TelemetryEventName' = $MyInvocation.MyCommand.Name
             'TelemetryProperties' = $telemetryProperties

diff --git a/GitHubMiscellaneous.ps1 b/GitHubMiscellaneous.ps1
@@ -77,7 +77,7 @@ function Get-GitHubRateLimit
     $params = @{
         'UriFragment' = 'rate_limit'
         'Method' = 'Get'
-        'Description' =  "Getting your API rate limit"
+        'Description' = "Getting your API rate limit"
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'NoStatus' = (Resolve-ParameterWithDefaultConfigurationValue -Name NoStatus -ConfigValueName DefaultNoStatus)
@@ -186,7 +186,7 @@ function ConvertFrom-GitHubMarkdown
             'UriFragment' = 'markdown'
             'Body' = (ConvertTo-Json -InputObject $hashBody)
             'Method' = 'Post'
-            'Description' =  "Converting Markdown to HTML"
+            'Description' = "Converting Markdown to HTML"
             'AccessToken' = $AccessToken
             'TelemetryEventName' = $MyInvocation.MyCommand.Name
             'TelemetryProperties' = $telemetryProperties
@@ -345,7 +345,7 @@ filter Get-GitHubLicense
     $params = @{
         'UriFragment' = $uriFragment
         'Method' = 'Get'
-        'Description' =  $description
+        'Description' = $description
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'TelemetryProperties' = $telemetryProperties
@@ -425,7 +425,7 @@ function Get-GitHubEmoji
     $params = @{
         'UriFragment' = 'emojis'
         'Method' = 'Get'
-        'Description' =  "Getting all GitHub emojis"
+        'Description' = "Getting all GitHub emojis"
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'NoStatus' = (Resolve-ParameterWithDefaultConfigurationValue -Name NoStatus -ConfigValueName DefaultNoStatus)
@@ -583,7 +583,7 @@ filter Get-GitHubCodeOfConduct
         'UriFragment' = $uriFragment
         'Method' = 'Get'
         'AcceptHeader' = $script:scarletWitchAcceptHeader
-        'Description' =  $description
+        'Description' = $description
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'TelemetryProperties' = $telemetryProperties
@@ -680,7 +680,7 @@ filter Get-GitHubGitIgnore
     $params = @{
         'UriFragment' = $uriFragment
         'Method' = 'Get'
-        'Description' =  $description
+        'Description' = $description
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'TelemetryProperties' = $telemetryProperties

diff --git a/GitHubOrganizations.ps1 b/GitHubOrganizations.ps1
@@ -67,7 +67,7 @@ filter Get-GitHubOrganizationMember
 
     $params = @{
         'UriFragment' = "orgs/$OrganizationName/members"
-        'Description' =  "Getting members for $OrganizationName"
+        'Description' = "Getting members for $OrganizationName"
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'TelemetryProperties' = $telemetryProperties
@@ -144,7 +144,7 @@ filter Test-GitHubOrganizationMember
 
     $params = @{
         'UriFragment' = "orgs/$OrganizationName/members/$UserName"
-        'Description' =  "Checking if $UserName is a member of $OrganizationName"
+        'Description' = "Checking if $UserName is a member of $OrganizationName"
         'Method' = 'Get'
         'ExtendedResult' = $true
         'AccessToken' = $AccessToken

diff --git a/GitHubPullRequests.ps1 b/GitHubPullRequests.ps1
@@ -180,7 +180,7 @@ filter Get-GitHubPullRequest
 
     $params = @{
         'UriFragment' = $uriFragment + '?' +  ($getParams -join '&')
-        'Description' =  $description
+        'Description' = $description
         'AcceptHeader' = $script:symmetraAcceptHeader
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name

diff --git a/GitHubReleases.ps1 b/GitHubReleases.ps1
@@ -214,7 +214,7 @@ filter Get-GitHubRelease
 
     $params = @{
         'UriFragment' = $uriFragment
-        'Description' =  $description
+        'Description' = $description
         'AccessToken' = $AccessToken
         'TelemetryEventName' = $MyInvocation.MyCommand.Name
         'TelemetryProperties' = $telemetryProperties