Skip to content

Commit ab536c7

Browse files
HowardWoloskyHowardWolosky
authored
Add missing .SYNOPSIS to functions (#293)
Now that we are generating help documentation for the module, we want to ensure that we have a .SYNOPSIS for every function CBH.
1 parent 4379a46 commit ab536c7

9 files changed

+102
-9
lines changed

Diff for: ‎GitHubAssignees.ps1

+12
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
filter Get-GitHubAssignee
55
{
66
<#
7+
.SYNOPSIS
8+
Lists the available assignees for issues in a repository.
9+
710
.DESCRIPTION
811
Lists the available assignees for issues in a repository.
912
@@ -103,6 +106,9 @@ filter Get-GitHubAssignee
103106
filter Test-GitHubAssignee
104107
{
105108
<#
109+
.SYNOPSIS
110+
Checks if a user has permission to be assigned to an issue in this repository.
111+
106112
.DESCRIPTION
107113
Checks if a user has permission to be assigned to an issue in this repository.
108114
@@ -230,6 +236,9 @@ filter Test-GitHubAssignee
230236
function Add-GitHubAssignee
231237
{
232238
<#
239+
.SYNOPSIS
240+
Adds a list of assignees to a GitHub Issue for the given repository.
241+
233242
.DESCRIPTION
234243
Adds a list of assignees to a GitHub Issue for the given repository.
235244
@@ -415,6 +424,9 @@ function Add-GitHubAssignee
415424
function Remove-GitHubAssignee
416425
{
417426
<#
427+
.SYNOPSIS
428+
Removes an assignee from a GitHub issue.
429+
418430
.DESCRIPTION
419431
Removes an assignee from a GitHub issue.
420432

Diff for: ‎GitHubCore.ps1

+4-1
Original file line numberDiff line numberDiff line change
@@ -1046,8 +1046,11 @@ filter ConvertTo-SmarterObject
10461046
function Get-MediaAcceptHeader
10471047
{
10481048
<#
1049+
.SYNOPSIS
1050+
Returns a formatted AcceptHeader based on the requested MediaType.
1051+
10491052
.DESCRIPTION
1050-
Returns a formatted AcceptHeader based on the requested MediaType
1053+
Returns a formatted AcceptHeader based on the requested MediaType.
10511054
10521055
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
10531056

Diff for: ‎GitHubEvents.ps1

+4-1
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,11 @@
1010
filter Get-GitHubEvent
1111
{
1212
<#
13+
.SYNOPSIS
14+
Lists events for an issue, repository, or a single event.
15+
1316
.DESCRIPTION
14-
Lists events for an issue, repository, or a single event
17+
Lists events for an issue, repository, or a single event.
1518
1619
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
1720

Diff for: ‎GitHubIssueComments.ps1

+15-3
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
filter Get-GitHubIssueComment
1212
{
1313
<#
14+
.SYNOPSIS
15+
Get the Issue comments for a given GitHub repository.
16+
1417
.DESCRIPTION
1518
Get the Issue comments for a given GitHub repository.
1619
@@ -279,8 +282,11 @@ filter Get-GitHubIssueComment
279282
filter New-GitHubIssueComment
280283
{
281284
<#
285+
.SYNOPSIS
286+
Creates a new GitHub comment for an issue for the given repository.
287+
282288
.DESCRIPTION
283-
Creates a new GitHub comment for an issue for the given repository
289+
Creates a new GitHub comment for an issue for the given repository.
284290
285291
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
286292
@@ -414,8 +420,11 @@ filter New-GitHubIssueComment
414420
filter Set-GitHubIssueComment
415421
{
416422
<#
423+
.SYNOPSIS
424+
Modifies an existing comment in an issue for the given repository.
425+
417426
.DESCRIPTION
418-
Modifies an existing comment in an issue for the given repository
427+
Modifies an existing comment in an issue for the given repository.
419428
420429
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
421430
@@ -565,8 +574,11 @@ filter Set-GitHubIssueComment
565574
filter Remove-GitHubIssueComment
566575
{
567576
<#
577+
.SYNOPSIS
578+
Deletes a GitHub comment from an Issue in the given repository.
579+
568580
.DESCRIPTION
569-
Deletes a GitHub comment from an Issue in the given repository
581+
Deletes a GitHub comment from an Issue in the given repository.
570582
571583
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
572584

Diff for: ‎GitHubLabels.ps1

+9
Original file line numberDiff line numberDiff line change
@@ -795,6 +795,9 @@ filter Initialize-GitHubLabel
795795
function Add-GitHubIssueLabel
796796
{
797797
<#
798+
.SYNOPSIS
799+
Adds a label to an issue in the given GitHub repository.
800+
798801
.DESCRIPTION
799802
Adds a label to an issue in the given GitHub repository.
800803
@@ -960,6 +963,9 @@ function Add-GitHubIssueLabel
960963
function Set-GitHubIssueLabel
961964
{
962965
<#
966+
.SYNOPSIS
967+
Replaces labels on an issue in the given GitHub repository.
968+
963969
.DESCRIPTION
964970
Replaces labels on an issue in the given GitHub repository.
965971
@@ -1159,6 +1165,9 @@ function Set-GitHubIssueLabel
11591165
filter Remove-GitHubIssueLabel
11601166
{
11611167
<#
1168+
.SYNOPSIS
1169+
Deletes a label from an issue in the given GitHub repository.
1170+
11621171
.DESCRIPTION
11631172
Deletes a label from an issue in the given GitHub repository.
11641173

Diff for: ‎GitHubMilestones.ps1

+15-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ $script:minimumHoursToEnsureDesiredDateInPacificTime = 9
1414
filter Get-GitHubMilestone
1515
{
1616
<#
17+
.SYNOPSIS
18+
Get the milestones for a given GitHub repository.
19+
1720
.DESCRIPTION
1821
Get the milestones for a given GitHub repository.
1922
@@ -205,8 +208,11 @@ filter Get-GitHubMilestone
205208
filter New-GitHubMilestone
206209
{
207210
<#
211+
.SYNOPSIS
212+
Creates a new GitHub milestone for the given repository.
213+
208214
.DESCRIPTION
209-
Creates a new GitHub milestone for the given repository
215+
Creates a new GitHub milestone for the given repository.
210216
211217
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
212218
@@ -380,8 +386,11 @@ filter New-GitHubMilestone
380386
filter Set-GitHubMilestone
381387
{
382388
<#
389+
.SYNOPSIS
390+
Update an existing milestone for the given repository.
391+
383392
.DESCRIPTION
384-
Update an existing milestone for the given repository
393+
Update an existing milestone for the given repository.
385394
386395
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
387396
@@ -579,8 +588,11 @@ filter Set-GitHubMilestone
579588
filter Remove-GitHubMilestone
580589
{
581590
<#
591+
.SYNOPSIS
592+
Deletes a GitHub milestone for the given repository.
593+
582594
.DESCRIPTION
583-
Deletes a GitHub milestone for the given repository
595+
Deletes a GitHub milestone for the given repository.
584596
585597
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
586598

Diff for: ‎GitHubProjectCards.ps1

+15
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
filter Get-GitHubProjectCard
1111
{
1212
<#
13+
.SYNOPSIS
14+
Get the cards for a given GitHub Project Column.
15+
1316
.DESCRIPTION
1417
Get the cards for a given GitHub Project Column.
1518
@@ -124,6 +127,9 @@ filter Get-GitHubProjectCard
124127
filter New-GitHubProjectCard
125128
{
126129
<#
130+
.SYNOPSIS
131+
Creates a new card for a GitHub project.
132+
127133
.DESCRIPTION
128134
Creates a new card for a GitHub project.
129135
@@ -260,6 +266,9 @@ filter New-GitHubProjectCard
260266
filter Set-GitHubProjectCard
261267
{
262268
<#
269+
.SYNOPSIS
270+
Modify a GitHub Project Card.
271+
263272
.DESCRIPTION
264273
Modify a GitHub Project Card.
265274
@@ -386,6 +395,9 @@ filter Set-GitHubProjectCard
386395
filter Remove-GitHubProjectCard
387396
{
388397
<#
398+
.SYNOPSIS
399+
Removes a project card.
400+
389401
.DESCRIPTION
390402
Removes a project card.
391403
@@ -468,6 +480,9 @@ filter Remove-GitHubProjectCard
468480
filter Move-GitHubProjectCard
469481
{
470482
<#
483+
.SYNOPSIS
484+
Move a GitHub Project Card.
485+
471486
.DESCRIPTION
472487
Move a GitHub Project Card.
473488

Diff for: ‎GitHubProjectColumns.ps1

+15
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
filter Get-GitHubProjectColumn
1111
{
1212
<#
13+
.SYNOPSIS
14+
Get the columns for a given GitHub Project.
15+
1316
.DESCRIPTION
1417
Get the columns for a given GitHub Project.
1518
@@ -101,6 +104,9 @@ filter Get-GitHubProjectColumn
101104
filter New-GitHubProjectColumn
102105
{
103106
<#
107+
.SYNOPSIS
108+
Creates a new column for a GitHub project.
109+
104110
.DESCRIPTION
105111
Creates a new column for a GitHub project.
106112
@@ -183,6 +189,9 @@ filter New-GitHubProjectColumn
183189
filter Set-GitHubProjectColumn
184190
{
185191
<#
192+
.SYNOPSIS
193+
Modify a GitHub Project Column.
194+
186195
.DESCRIPTION
187196
Modify a GitHub Project Column.
188197
@@ -271,6 +280,9 @@ filter Set-GitHubProjectColumn
271280
filter Remove-GitHubProjectColumn
272281
{
273282
<#
283+
.SYNOPSIS
284+
Removes the column for a project.
285+
274286
.DESCRIPTION
275287
Removes the column for a project.
276288
@@ -354,6 +366,9 @@ filter Remove-GitHubProjectColumn
354366
filter Move-GitHubProjectColumn
355367
{
356368
<#
369+
.SYNOPSIS
370+
Move a GitHub Project Column.
371+
357372
.DESCRIPTION
358373
Move a GitHub Project Column.
359374

Diff for: ‎GitHubProjects.ps1

+13-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
filter Get-GitHubProject
1111
{
1212
<#
13+
.SYNOPSIS
14+
Get the projects for a given GitHub user, repository or organization.
15+
1316
.DESCRIPTION
1417
Get the projects for a given GitHub user, repository or organization.
1518
@@ -212,8 +215,11 @@ filter Get-GitHubProject
212215
filter New-GitHubProject
213216
{
214217
<#
218+
.SYNOPSIS
219+
Creates a new GitHub project for the given repository.
220+
215221
.DESCRIPTION
216-
Creates a new GitHub project for the given repository
222+
Creates a new GitHub project for the given repository.
217223
218224
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
219225
@@ -395,6 +401,9 @@ filter New-GitHubProject
395401
filter Set-GitHubProject
396402
{
397403
<#
404+
.SYNOPSIS
405+
Modify a GitHub Project.
406+
398407
.DESCRIPTION
399408
Modify a GitHub Project.
400409
@@ -543,6 +552,9 @@ filter Set-GitHubProject
543552
filter Remove-GitHubProject
544553
{
545554
<#
555+
.SYNOPSIS
556+
Removes the projects for a given GitHub repository.
557+
546558
.DESCRIPTION
547559
Removes the projects for a given GitHub repository.
548560

0 commit comments

Comments
 (0)