Skip to content

Commit 0bc09d2

Browse files
HowardWoloskyHowardWolosky
authored
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.
1 parent b70c7d4 commit 0bc09d2

17 files changed

+59
-55
lines changed

‎.vscode/settings.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
{
2+
"editor.rulers": [
3+
100
4+
],
25
"[powershell]": {
36
"files.trimTrailingWhitespace": true
47
},

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,8 @@ Here are some general guidelines
243243
reviewing/maintaining code. There are of course exceptions, but this is generally an enforced
244244
preference. The [Visual Studio Productivity Power Tools](https://visualstudiogallery.msdn.microsoft.com/34ebc6a2-2777-421d-8914-e29c1dfa7f5d)
245245
extension has a "Column Guides" feature that makes it easy to add a Guideline in column 100
246-
to make it really obvious when coding.
246+
to make it really obvious when coding. If you use VS Code, this module's `.vscode/settings.json`
247+
configures that for you automatically.
247248

248249
----------
249250

‎GitHubAssignees.ps1‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ filter Get-GitHubAssignee
100100

101101
$params = @{
102102
'UriFragment' = "repos/$OwnerName/$RepositoryName/assignees"
103-
'Description' = "Getting assignee list for $RepositoryName"
103+
'Description' = "Getting assignee list for $RepositoryName"
104104
'AccessToken' = $AccessToken
105105
'TelemetryEventName' = $MyInvocation.MyCommand.Name
106106
'TelemetryProperties' = $telemetryProperties
@@ -228,7 +228,7 @@ filter Test-GitHubAssignee
228228
$params = @{
229229
'UriFragment' = "repos/$OwnerName/$RepositoryName/assignees/$Assignee"
230230
'Method' = 'Get'
231-
'Description' = "Checking permission for $Assignee for $RepositoryName"
231+
'Description' = "Checking permission for $Assignee for $RepositoryName"
232232
'AccessToken' = $AccessToken
233233
'TelemetryEventName' = $MyInvocation.MyCommand.Name
234234
'TelemetryProperties' = $telemetryProperties
@@ -411,7 +411,7 @@ function New-GitHubAssignee
411411
'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/assignees"
412412
'Body' = (ConvertTo-Json -InputObject $hashBody)
413413
'Method' = 'Post'
414-
'Description' = "Add assignees to issue $Issue for $RepositoryName"
414+
'Description' = "Add assignees to issue $Issue for $RepositoryName"
415415
'AccessToken' = $AccessToken
416416
'AcceptHeader' = $script:symmetraAcceptHeader
417417
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -603,7 +603,7 @@ function Remove-GitHubAssignee
603603
'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/assignees"
604604
'Body' = (ConvertTo-Json -InputObject $hashBody)
605605
'Method' = 'Delete'
606-
'Description' = "Removing assignees from issue $Issue for $RepositoryName"
606+
'Description' = "Removing assignees from issue $Issue for $RepositoryName"
607607
'AccessToken' = $AccessToken
608608
'AcceptHeader' = $script:symmetraAcceptHeader
609609
'TelemetryEventName' = $MyInvocation.MyCommand.Name

‎GitHubBranches.ps1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ filter Get-GitHubRepositoryBranch
144144

145145
$params = @{
146146
'UriFragment' = $uriFragment + '?' + ($getParams -join '&')
147-
'Description' = "Getting branches for $RepositoryName"
147+
'Description' = "Getting branches for $RepositoryName"
148148
'AccessToken' = $AccessToken
149149
'TelemetryEventName' = $MyInvocation.MyCommand.Name
150150
'TelemetryProperties' = $telemetryProperties

‎GitHubIssueComments.ps1‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ filter New-GitHubIssueComment
413413
'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/comments"
414414
'Body' = (ConvertTo-Json -InputObject $hashBody)
415415
'Method' = 'Post'
416-
'Description' = "Creating comment under issue $Issue for $RepositoryName"
416+
'Description' = "Creating comment under issue $Issue for $RepositoryName"
417417
'AccessToken' = $AccessToken
418418
'AcceptHeader' = (Get-MediaAcceptHeader -MediaType $MediaType -AsJson -AcceptHeader $squirrelGirlAcceptHeader)
419419
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -556,7 +556,7 @@ filter Set-GitHubIssueComment
556556
'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/comments/$Comment"
557557
'Body' = (ConvertTo-Json -InputObject $hashBody)
558558
'Method' = 'Patch'
559-
'Description' = "Update comment $Comment for $RepositoryName"
559+
'Description' = "Update comment $Comment for $RepositoryName"
560560
'AccessToken' = $AccessToken
561561
'AcceptHeader' = (Get-MediaAcceptHeader -MediaType $MediaType -AsJson -AcceptHeader $squirrelGirlAcceptHeader)
562562
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -693,7 +693,7 @@ filter Remove-GitHubIssueComment
693693
$params = @{
694694
'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/comments/$Comment"
695695
'Method' = 'Delete'
696-
'Description' = "Removing comment $Comment for $RepositoryName"
696+
'Description' = "Removing comment $Comment for $RepositoryName"
697697
'AccessToken' = $AccessToken
698698
'TelemetryEventName' = $MyInvocation.MyCommand.Name
699699
'TelemetryProperties' = $telemetryProperties

‎GitHubIssues.ps1‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ filter Get-GitHubIssue
357357

358358
$params = @{
359359
'UriFragment' = $uriFragment + '?' + ($getParams -join '&')
360-
'Description' = $description
360+
'Description' = $description
361361
'AcceptHeader' = (Get-MediaAcceptHeader -MediaType $MediaType -AsJson -AcceptHeader $symmetraAcceptHeader)
362362
'AccessToken' = $AccessToken
363363
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -484,7 +484,7 @@ filter Get-GitHubIssueTimeline
484484

485485
$params = @{
486486
'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/timeline"
487-
'Description' = "Getting timeline for Issue #$Issue in $RepositoryName"
487+
'Description' = "Getting timeline for Issue #$Issue in $RepositoryName"
488488
'AcceptHeader' = $script:mockingbirdAcceptHeader
489489
'AccessToken' = $AccessToken
490490
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -643,7 +643,7 @@ filter New-GitHubIssue
643643
'UriFragment' = "/repos/$OwnerName/$RepositoryName/issues"
644644
'Body' = (ConvertTo-Json -InputObject $hashBody)
645645
'Method' = 'Post'
646-
'Description' = "Creating new Issue ""$Title"" on $RepositoryName"
646+
'Description' = "Creating new Issue ""$Title"" on $RepositoryName"
647647
'AcceptHeader' = (Get-MediaAcceptHeader -MediaType $MediaType -AsJson -AcceptHeader $symmetraAcceptHeader)
648648
'AccessToken' = $AccessToken
649649
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -823,7 +823,7 @@ filter Update-GitHubIssue
823823
'UriFragment' = "/repos/$OwnerName/$RepositoryName/issues/$Issue"
824824
'Body' = (ConvertTo-Json -InputObject $hashBody)
825825
'Method' = 'Patch'
826-
'Description' = "Updating Issue #$Issue on $RepositoryName"
826+
'Description' = "Updating Issue #$Issue on $RepositoryName"
827827
'AcceptHeader' = (Get-MediaAcceptHeader -MediaType $MediaType -AsJson -AcceptHeader $symmetraAcceptHeader)
828828
'AccessToken' = $AccessToken
829829
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -956,7 +956,7 @@ filter Lock-GitHubIssue
956956
'UriFragment' = "/repos/$OwnerName/$RepositoryName/issues/$Issue/lock"
957957
'Body' = (ConvertTo-Json -InputObject $hashBody)
958958
'Method' = 'Put'
959-
'Description' = "Locking Issue #$Issue on $RepositoryName"
959+
'Description' = "Locking Issue #$Issue on $RepositoryName"
960960
'AcceptHeader' = $script:sailorVAcceptHeader
961961
'AccessToken' = $AccessToken
962962
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -1066,7 +1066,7 @@ filter Unlock-GitHubIssue
10661066
$params = @{
10671067
'UriFragment' = "/repos/$OwnerName/$RepositoryName/issues/$Issue/lock"
10681068
'Method' = 'Delete'
1069-
'Description' = "Unlocking Issue #$Issue on $RepositoryName"
1069+
'Description' = "Unlocking Issue #$Issue on $RepositoryName"
10701070
'AcceptHeader' = $script:sailorVAcceptHeader
10711071
'AccessToken' = $AccessToken
10721072
'TelemetryEventName' = $MyInvocation.MyCommand.Name

‎GitHubLabels.ps1‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ filter Get-GitHubLabel
182182

183183
$params = @{
184184
'UriFragment' = $uriFragment
185-
'Description' = $description
185+
'Description' = $description
186186
'AcceptHeader' = $script:symmetraAcceptHeader
187187
'AccessToken' = $AccessToken
188188
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -327,7 +327,7 @@ filter New-GitHubLabel
327327
'UriFragment' = "repos/$OwnerName/$RepositoryName/labels"
328328
'Body' = (ConvertTo-Json -InputObject $hashBody)
329329
'Method' = 'Post'
330-
'Description' = "Creating label $Label in $RepositoryName"
330+
'Description' = "Creating label $Label in $RepositoryName"
331331
'AcceptHeader' = $script:symmetraAcceptHeader
332332
'AccessToken' = $AccessToken
333333
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -474,7 +474,7 @@ filter Remove-GitHubLabel
474474
$params = @{
475475
'UriFragment' = "repos/$OwnerName/$RepositoryName/labels/$Label"
476476
'Method' = 'Delete'
477-
'Description' = "Deleting label $Label from $RepositoryName"
477+
'Description' = "Deleting label $Label from $RepositoryName"
478478
'AcceptHeader' = $script:symmetraAcceptHeader
479479
'AccessToken' = $AccessToken
480480
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -626,7 +626,7 @@ filter Update-GitHubLabel
626626
'UriFragment' = "repos/$OwnerName/$RepositoryName/labels/$Label"
627627
'Body' = (ConvertTo-Json -InputObject $hashBody)
628628
'Method' = 'Patch'
629-
'Description' = "Updating label $Label"
629+
'Description' = "Updating label $Label"
630630
'AcceptHeader' = $script:symmetraAcceptHeader
631631
'AccessToken' = $AccessToken
632632
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -928,7 +928,7 @@ function Add-GitHubIssueLabel
928928
'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/labels"
929929
'Body' = (ConvertTo-Json -InputObject $hashBody)
930930
'Method' = 'Post'
931-
'Description' = "Adding labels to issue $Issue in $RepositoryName"
931+
'Description' = "Adding labels to issue $Issue in $RepositoryName"
932932
'AcceptHeader' = $script:symmetraAcceptHeader
933933
'AccessToken' = $AccessToken
934934
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -1117,7 +1117,7 @@ function Set-GitHubIssueLabel
11171117
'UriFragment' = "repos/$OwnerName/$RepositoryName/issues/$Issue/labels"
11181118
'Body' = (ConvertTo-Json -InputObject $hashBody)
11191119
'Method' = 'Put'
1120-
'Description' = "Replacing labels to issue $Issue in $RepositoryName"
1120+
'Description' = "Replacing labels to issue $Issue in $RepositoryName"
11211121
'AcceptHeader' = $script:symmetraAcceptHeader
11221122
'AccessToken' = $AccessToken
11231123
'TelemetryEventName' = $MyInvocation.MyCommand.Name
@@ -1275,7 +1275,7 @@ filter Remove-GitHubIssueLabel
12751275
$params = @{
12761276
'UriFragment' = "/repos/$OwnerName/$RepositoryName/issues/$Issue/labels/$Label"
12771277
'Method' = 'Delete'
1278-
'Description' = $description
1278+
'Description' = $description
12791279
'AcceptHeader' = $script:symmetraAcceptHeader
12801280
'AccessToken' = $AccessToken
12811281
'TelemetryEventName' = $MyInvocation.MyCommand.Name

‎GitHubMilestones.ps1‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,7 @@ filter New-GitHubMilestone
380380
'UriFragment' = "repos/$OwnerName/$RepositoryName/milestones"
381381
'Body' = (ConvertTo-Json -InputObject $hashBody)
382382
'Method' = 'Post'
383-
'Description' = "Creating milestone for $RepositoryName"
383+
'Description' = "Creating milestone for $RepositoryName"
384384
'AccessToken' = $AccessToken
385385
'TelemetryEventName' = $MyInvocation.MyCommand.Name
386386
'TelemetryProperties' = $telemetryProperties
@@ -571,7 +571,7 @@ filter Set-GitHubMilestone
571571
'UriFragment' = "repos/$OwnerName/$RepositoryName/milestones/$Milestone"
572572
'Body' = (ConvertTo-Json -InputObject $hashBody)
573573
'Method' = 'Patch'
574-
'Description' = "Setting milestone $Milestone for $RepositoryName"
574+
'Description' = "Setting milestone $Milestone for $RepositoryName"
575575
'AccessToken' = $AccessToken
576576
'TelemetryEventName' = $MyInvocation.MyCommand.Name
577577
'TelemetryProperties' = $telemetryProperties
@@ -714,7 +714,7 @@ filter Remove-GitHubMilestone
714714
$params = @{
715715
'UriFragment' = "repos/$OwnerName/$RepositoryName/milestones/$Milestone"
716716
'Method' = 'Delete'
717-
'Description' = "Removing milestone $Milestone for $RepositoryName"
717+
'Description' = "Removing milestone $Milestone for $RepositoryName"
718718
'AccessToken' = $AccessToken
719719
'TelemetryEventName' = $MyInvocation.MyCommand.Name
720720
'TelemetryProperties' = $telemetryProperties

‎GitHubMiscellaneous.ps1‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ function Get-GitHubRateLimit
7777
$params = @{
7878
'UriFragment' = 'rate_limit'
7979
'Method' = 'Get'
80-
'Description' = "Getting your API rate limit"
80+
'Description' = "Getting your API rate limit"
8181
'AccessToken' = $AccessToken
8282
'TelemetryEventName' = $MyInvocation.MyCommand.Name
8383
'NoStatus' = (Resolve-ParameterWithDefaultConfigurationValue -Name NoStatus -ConfigValueName DefaultNoStatus)
@@ -186,7 +186,7 @@ function ConvertFrom-GitHubMarkdown
186186
'UriFragment' = 'markdown'
187187
'Body' = (ConvertTo-Json -InputObject $hashBody)
188188
'Method' = 'Post'
189-
'Description' = "Converting Markdown to HTML"
189+
'Description' = "Converting Markdown to HTML"
190190
'AccessToken' = $AccessToken
191191
'TelemetryEventName' = $MyInvocation.MyCommand.Name
192192
'TelemetryProperties' = $telemetryProperties
@@ -345,7 +345,7 @@ filter Get-GitHubLicense
345345
$params = @{
346346
'UriFragment' = $uriFragment
347347
'Method' = 'Get'
348-
'Description' = $description
348+
'Description' = $description
349349
'AccessToken' = $AccessToken
350350
'TelemetryEventName' = $MyInvocation.MyCommand.Name
351351
'TelemetryProperties' = $telemetryProperties
@@ -425,7 +425,7 @@ function Get-GitHubEmoji
425425
$params = @{
426426
'UriFragment' = 'emojis'
427427
'Method' = 'Get'
428-
'Description' = "Getting all GitHub emojis"
428+
'Description' = "Getting all GitHub emojis"
429429
'AccessToken' = $AccessToken
430430
'TelemetryEventName' = $MyInvocation.MyCommand.Name
431431
'NoStatus' = (Resolve-ParameterWithDefaultConfigurationValue -Name NoStatus -ConfigValueName DefaultNoStatus)
@@ -583,7 +583,7 @@ filter Get-GitHubCodeOfConduct
583583
'UriFragment' = $uriFragment
584584
'Method' = 'Get'
585585
'AcceptHeader' = $script:scarletWitchAcceptHeader
586-
'Description' = $description
586+
'Description' = $description
587587
'AccessToken' = $AccessToken
588588
'TelemetryEventName' = $MyInvocation.MyCommand.Name
589589
'TelemetryProperties' = $telemetryProperties
@@ -680,7 +680,7 @@ filter Get-GitHubGitIgnore
680680
$params = @{
681681
'UriFragment' = $uriFragment
682682
'Method' = 'Get'
683-
'Description' = $description
683+
'Description' = $description
684684
'AccessToken' = $AccessToken
685685
'TelemetryEventName' = $MyInvocation.MyCommand.Name
686686
'TelemetryProperties' = $telemetryProperties

‎GitHubOrganizations.ps1‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ filter Get-GitHubOrganizationMember
6767

6868
$params = @{
6969
'UriFragment' = "orgs/$OrganizationName/members"
70-
'Description' = "Getting members for $OrganizationName"
70+
'Description' = "Getting members for $OrganizationName"
7171
'AccessToken' = $AccessToken
7272
'TelemetryEventName' = $MyInvocation.MyCommand.Name
7373
'TelemetryProperties' = $telemetryProperties
@@ -144,7 +144,7 @@ filter Test-GitHubOrganizationMember
144144

145145
$params = @{
146146
'UriFragment' = "orgs/$OrganizationName/members/$UserName"
147-
'Description' = "Checking if $UserName is a member of $OrganizationName"
147+
'Description' = "Checking if $UserName is a member of $OrganizationName"
148148
'Method' = 'Get'
149149
'ExtendedResult' = $true
150150
'AccessToken' = $AccessToken

0 commit comments

Comments
 (0)