Skip to content

Commit 6735ba5

Browse files
authored
spelling fixes (#165)
1 parent 3fab724 commit 6735ba5

23 files changed

+92
-92
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -301,14 +301,14 @@ Install-Module -Name Pester
301301
#### Configuring Your Environment
302302
The tests intentionally do not mock out interaction with the real GitHub API, as we want to know
303303
when our interaction with the API has been broken. That means that to execute the tests, you will
304-
need Administrator privelege for an account. For our purposes, we have a "test" account that our
304+
need Administrator privilege for an account. For our purposes, we have a "test" account that our
305305
team uses for having the tests [run automated](#automated-tests). For you to run the tests locally,
306306
you must make a couple changes:
307307

308-
1. Choose if you'll be executing the tests on your own pesonal account or your own test account
308+
1. Choose if you'll be executing the tests on your own personal account or your own test account
309309
(the tests should be non-destructive, but ... hey ... we are developing code here, mistakes happen.)
310310
2. Update your local copy of [tests/config/Settings.ps1](./tests/config/Settings.ps1) to note
311-
the `OwerName` and `OrganizationName` that the tests will be running under.
311+
the `OwnerName` and `OrganizationName` that the tests will be running under.
312312
> While you can certainly check-in this file to your own fork, please DO NOT include your
313313
> changes as part of any pull request that you may make. The `.gitignore` file tries
314314
> to help prevent that.
@@ -358,7 +358,7 @@ The [Azure DevOps pipeline](https://dev.azure.com/ms/PowerShellForGitHub/_build?
358358
has been [configured](https://github.com/microsoft/PowerShellForGitHub/blob/master/build/pipelines/templates/run-unitTests.yaml#L25-L28)
359359
to execute the tests against a test GitHub account (for the user `PowerShellForGitHubTeam`,
360360
and the org `PowerShellForGitHubTeamTestOrg`). You will see the AccessToken being referenced there
361-
as well...it is stored, encryted, within Azure DevOps. It is not accessible for use outside of
361+
as well...it is stored, encrypted, within Azure DevOps. It is not accessible for use outside of
362362
the CI pipeline. To run the tests locally with your own account, see
363363
[configuring-your-environment](#configuring-your-environment).
364364

GitHubAnalytics.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ function Group-GitHubIssue
3535
#>
3636
[CmdletBinding(
3737
SupportsShouldProcess,
38-
DefaultParametersetName='Weekly')]
38+
DefaultParameterSetName='Weekly')]
3939
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
4040
param
4141
(
@@ -128,7 +128,7 @@ function Group-GitHubPullRequest
128128
#>
129129
[CmdletBinding(
130130
SupportsShouldProcess,
131-
DefaultParametersetName='Weekly')]
131+
DefaultParameterSetName='Weekly')]
132132
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
133133
param
134134
(

GitHubAssignees.ps1

+6-6
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ function Get-GitHubAssignee
3333
If not supplied here, the DefaultNoStatus configuration property value will be used.
3434
3535
.EXAMPLE
36-
Get-GitHubAsigneeList -OwnerName Microsoft -RepositoryName PowerShellForGitHub
36+
Get-GitHubAssigneeList -OwnerName Microsoft -RepositoryName PowerShellForGitHub
3737
3838
Lists the available assignees for issues from the Microsoft\PowerShellForGitHub project.
3939
#>
4040
[CmdletBinding(
4141
SupportsShouldProcess,
42-
DefaultParametersetName='Elements')]
42+
DefaultParameterSetName='Elements')]
4343
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
4444
param(
4545
[Parameter(ParameterSetName='Elements')]
@@ -125,7 +125,7 @@ function Test-GitHubAssignee
125125
#>
126126
[CmdletBinding(
127127
SupportsShouldProcess,
128-
DefaultParametersetName='Elements')]
128+
DefaultParameterSetName='Elements')]
129129
[OutputType([bool])]
130130
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
131131
param(
@@ -156,7 +156,7 @@ function Test-GitHubAssignee
156156
$telemetryProperties = @{
157157
'OwnerName' = (Get-PiiSafeString -PlainText $OwnerName)
158158
'RepositoryName' = (Get-PiiSafeString -PlainText $RepositoryName)
159-
'Asignee' = (Get-PiiSafeString -PlainText $Assignee)
159+
'Assignee' = (Get-PiiSafeString -PlainText $Assignee)
160160
}
161161

162162
$params = @{
@@ -226,7 +226,7 @@ function New-GithubAssignee
226226
#>
227227
[CmdletBinding(
228228
SupportsShouldProcess,
229-
DefaultParametersetName='Elements')]
229+
DefaultParameterSetName='Elements')]
230230
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
231231
param(
232232
[Parameter(ParameterSetName='Elements')]
@@ -328,7 +328,7 @@ function Remove-GithubAssignee
328328
#>
329329
[CmdletBinding(
330330
SupportsShouldProcess,
331-
DefaultParametersetName='Elements')]
331+
DefaultParameterSetName='Elements')]
332332
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
333333
param(
334334
[Parameter(ParameterSetName='Elements')]

GitHubBranches.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ function Get-GitHubRepositoryBranch
2626
them individually.
2727
2828
.PARAMETER Name
29-
Name of the specific branch to be retieved. If not supplied, all branches will be retrieved.
29+
Name of the specific branch to be retrieved. If not supplied, all branches will be retrieved.
3030
3131
.PARAMETER AccessToken
3232
If provided, this will be used as the AccessToken for authentication with the
@@ -53,7 +53,7 @@ function Get-GitHubRepositoryBranch
5353
#>
5454
[CmdletBinding(
5555
SupportsShouldProcess,
56-
DefaultParametersetName='Elements')]
56+
DefaultParameterSetName='Elements')]
5757
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
5858
[Alias('Get-GitHubBranch')]
5959
param(

GitHubComments.ps1

+4-4
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ function Get-GitHubComment
6262
#>
6363
[CmdletBinding(
6464
SupportsShouldProcess,
65-
DefaultParametersetName='RepositoryElements')]
65+
DefaultParameterSetName='RepositoryElements')]
6666
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
6767
param(
6868
[Parameter(Mandatory, ParameterSetName='RepositoryElements')]
@@ -242,7 +242,7 @@ function New-GitHubComment
242242
#>
243243
[CmdletBinding(
244244
SupportsShouldProcess,
245-
DefaultParametersetName='Elements')]
245+
DefaultParameterSetName='Elements')]
246246
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
247247
param(
248248
[Parameter(ParameterSetName='Elements')]
@@ -353,7 +353,7 @@ function Set-GitHubComment
353353
#>
354354
[CmdletBinding(
355355
SupportsShouldProcess,
356-
DefaultParametersetName='Elements')]
356+
DefaultParameterSetName='Elements')]
357357
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
358358
param(
359359
[Parameter(ParameterSetName='Elements')]
@@ -453,7 +453,7 @@ function Remove-GitHubComment
453453
#>
454454
[CmdletBinding(
455455
SupportsShouldProcess,
456-
DefaultParametersetName='Elements')]
456+
DefaultParameterSetName='Elements')]
457457
[Alias('Delete-GitHubComment')]
458458
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
459459
param(

GitHubConfiguration.ps1

+5-5
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ function Set-GitHubConfiguration
5454
<#
5555
.SYNOPSIS
5656
Change the value of a configuration property for the PowerShellForGitHub module,
57-
for the sesion only, or globally for this user.
57+
for the session only, or globally for this user.
5858
5959
.DESCRIPTION
6060
Change the value of a configuration property for the PowerShellForGitHub module,
61-
for the sesion only, or globally for this user.
61+
for the session only, or globally for this user.
6262
6363
A single call to this method can set any number or combination of properties.
6464
@@ -101,7 +101,7 @@ function Set-GitHubConfiguration
101101
data to telemetry (if telemetry hasn't been disabled via DisableTelemetry).
102102
103103
.PARAMETER DisableSmarterObjects
104-
By deffault, this module will modify all objects returned by the API calls to update
104+
By default, this module will modify all objects returned by the API calls to update
105105
any properties that can be converted to objects (like strings for Date/Time's being
106106
converted to real DateTime objects). Enable this property if you desire getting back
107107
the unmodified version of the object from the API.
@@ -481,7 +481,7 @@ function Reset-GitHubConfiguration
481481
.EXAMPLE
482482
Reset-GitHubConfiguration
483483
484-
Deletes the local configuration file and loads in all default configration values.
484+
Deletes the local configuration file and loads in all default configuration values.
485485
486486
.NOTES
487487
This command will not clear your authentication token. Please use Clear-GitHubAuthentication to accomplish that.
@@ -752,7 +752,7 @@ function Resolve-ParameterWithDefaultConfigurationValue
752752
The name of the parameter in BoundParameters.
753753
754754
.PARAMETER ConfigValueName
755-
The name of the cofiguration property that should be used as default if Name doesn't exist
755+
The name of the configuration property that should be used as default if Name doesn't exist
756756
in BoundParameters.
757757
758758
.PARAMETER NonEmptyStringRequired

GitHubContents.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ function Get-GitHubContent
6262
#>
6363
[CmdletBinding(
6464
SupportsShouldProcess,
65-
DefaultParametersetName = 'Elements')]
65+
DefaultParameterSetName = 'Elements')]
6666
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification = "Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
6767
param(
6868
[Parameter(Mandatory, ParameterSetName = 'Elements')]

GitHubCore.ps1

+10-10
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ function Invoke-GHRestMethod
2828
2929
.PARAMETER UriFragment
3030
The unique, tail-end, of the REST URI that indicates what Store REST action will
31-
be peformed. This should not start with a leading "/".
31+
be performed. This should not start with a leading "/".
3232
3333
.PARAMETER Method
34-
The type of REST method being peformed. This only supports a reduced set of the
34+
The type of REST method being performed. This only supports a reduced set of the
3535
possible REST methods (delete, get, post, put).
3636
3737
.PARAMETER Description
@@ -77,7 +77,7 @@ function Invoke-GHRestMethod
7777
the background, enabling the command prompt to provide status information.
7878
7979
.OUTPUTS
80-
[PSCutomObject] - The result of the REST operation, in whatever form it comes in.
80+
[PSCustomObject] - The result of the REST operation, in whatever form it comes in.
8181
8282
.EXAMPLE
8383
Invoke-GHRestMethod -UriFragment "applications/" -Method Get -Description "Get first 10 applications"
@@ -543,7 +543,7 @@ function Invoke-GHRestMethodMultipleResult
543543
544544
.PARAMETER UriFragment
545545
The unique, tail-end, of the REST URI that indicates what Store REST action will
546-
be peformed. This should *not* include the 'top' and 'max' parameters. These
546+
be performed. This should *not* include the 'top' and 'max' parameters. These
547547
will be automatically added as needed.
548548
549549
.PARAMETER Description
@@ -576,7 +576,7 @@ function Invoke-GHRestMethodMultipleResult
576576
no bucket value will be used.
577577
578578
.PARAMETER SinglePage
579-
By default, this function will automtically call any follow-up "nextLinks" provided by
579+
By default, this function will automatically call any follow-up "nextLinks" provided by
580580
the return value in order to retrieve the entire result set. If this switch is provided,
581581
only the first "page" of results will be retrieved, and the "nextLink" links will not be
582582
followed.
@@ -588,7 +588,7 @@ function Invoke-GHRestMethodMultipleResult
588588
the background, enabling the command prompt to provide status information.
589589
590590
.OUTPUTS
591-
[PSCutomObject[]] - The result of the REST operation, in whatever form it comes in.
591+
[PSCustomObject[]] - The result of the REST operation, in whatever form it comes in.
592592
593593
.EXAMPLE
594594
Invoke-GHRestMethodMultipleResult -UriFragment "repos/PowerShell/PowerShellForGitHub/issues?state=all" -Description "Get all issues"
@@ -692,7 +692,7 @@ function Split-GitHubUri
692692
.DESCRIPTION
693693
Extracts the relevant elements of a GitHub repository Uri and returns the requested element.
694694
695-
Currently supports retrieving the OwnerName and the RepositoryName, when avaialable.
695+
Currently supports retrieving the OwnerName and the RepositoryName, when available.
696696
697697
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
698698
@@ -706,7 +706,7 @@ function Split-GitHubUri
706706
Returns the Repository Name from the Uri if it can be identified.
707707
708708
.OUTPUTS
709-
[PSCutomObject] - The OwnerName and RepositoryName elements from the provided URL
709+
[PSCustomObject] - The OwnerName and RepositoryName elements from the provided URL
710710
711711
.EXAMPLE
712712
Split-GitHubUri -Uri 'https://github.com/PowerShell/PowerShellForGitHub'
@@ -723,7 +723,7 @@ function Split-GitHubUri
723723
724724
PowerShell
725725
#>
726-
[CmdletBinding(DefaultParametersetName='RepositoryName')]
726+
[CmdletBinding(DefaultParameterSetName='RepositoryName')]
727727
param
728728
(
729729
[Parameter(Mandatory)]
@@ -788,7 +788,7 @@ function Resolve-RepositoryElements
788788
have no value.
789789
790790
.OUTPUTS
791-
[PSCutomObject] - The OwnerName and RepositoryName elements to be used
791+
[PSCustomObject] - The OwnerName and RepositoryName elements to be used
792792
#>
793793
[CmdletBinding(SupportsShouldProcess)]
794794
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]

GitHubEvents.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ function Get-GitHubEvent
4545
#>
4646
[CmdletBinding(
4747
SupportsShouldProcess,
48-
DefaultParametersetName='RepositoryElements')]
48+
DefaultParameterSetName='RepositoryElements')]
4949
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
5050
param(
5151
[Parameter(Mandatory, ParameterSetName='RepositoryElements')]

GitHubIssues.ps1

+9-9
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ function Get-GitHubIssue
3333
ownedAndMember: Retrieve issues across owned and member repositories
3434
3535
.PARAMETER Issue
36-
The number of specic Issue to retrieve. If not supplied, will return back all
36+
The number of specific Issue to retrieve. If not supplied, will return back all
3737
Issues for this Repository that match the specified criteria.
3838
3939
.PARAMETER IgnorePullRequests
@@ -117,7 +117,7 @@ function Get-GitHubIssue
117117
#>
118118
[CmdletBinding(
119119
SupportsShouldProcess,
120-
DefaultParametersetName='Elements')]
120+
DefaultParameterSetName='Elements')]
121121
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
122122
param(
123123
[Parameter(ParameterSetName='Elements')]
@@ -376,7 +376,7 @@ function Get-GitHubIssueTimeline
376376
#>
377377
[CmdletBinding(
378378
SupportsShouldProcess,
379-
DefaultParametersetName='Elements')]
379+
DefaultParameterSetName='Elements')]
380380
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
381381
param(
382382
[Parameter(ParameterSetName='Elements')]
@@ -456,7 +456,7 @@ function New-GitHubIssue
456456
Login(s) for Users to assign to the issue.
457457
458458
.PARAMETER Milestone
459-
The number of the mileston to associate this issue with.
459+
The number of the milestone to associate this issue with.
460460
461461
.PARAMETER Label
462462
Label(s) to associate with this issue.
@@ -484,7 +484,7 @@ function New-GitHubIssue
484484
#>
485485
[CmdletBinding(
486486
SupportsShouldProcess,
487-
DefaultParametersetName='Elements')]
487+
DefaultParameterSetName='Elements')]
488488
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
489489
param(
490490
[Parameter(ParameterSetName='Elements')]
@@ -591,7 +591,7 @@ function Update-GitHubIssue
591591
Provide an empty array to clear all existing assignees.
592592
593593
.PARAMETER Milestone
594-
The number of the mileston to associate this issue with.
594+
The number of the milestone to associate this issue with.
595595
Set to 0/$null to remove current.
596596
597597
.PARAMETER Label
@@ -624,7 +624,7 @@ function Update-GitHubIssue
624624
#>
625625
[CmdletBinding(
626626
SupportsShouldProcess,
627-
DefaultParametersetName='Elements')]
627+
DefaultParameterSetName='Elements')]
628628
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
629629
param(
630630
[Parameter(ParameterSetName='Elements')]
@@ -749,7 +749,7 @@ function Lock-GitHubIssue
749749
#>
750750
[CmdletBinding(
751751
SupportsShouldProcess,
752-
DefaultParametersetName='Elements')]
752+
DefaultParameterSetName='Elements')]
753753
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
754754
param(
755755
[Parameter(ParameterSetName='Elements')]
@@ -859,7 +859,7 @@ function Unlock-GitHubIssue
859859
#>
860860
[CmdletBinding(
861861
SupportsShouldProcess,
862-
DefaultParametersetName='Elements')]
862+
DefaultParameterSetName='Elements')]
863863
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
864864
param(
865865
[Parameter(ParameterSetName='Elements')]

0 commit comments

Comments
 (0)