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.
microsoft · Oct 5, 2020 · ab536c7 · ab536c7
1 parent 4379a46
commit ab536c7
Show file tree

Hide file tree

Showing 9 changed files with 102 additions and 9 deletions.
diff --git a/GitHubAssignees.ps1 b/GitHubAssignees.ps1
@@ -4,6 +4,9 @@
 filter Get-GitHubAssignee
 {
 <#
+    .SYNOPSIS
+        Lists the available assignees for issues in a repository.
+
     .DESCRIPTION
         Lists the available assignees for issues in a repository.
 
@@ -103,6 +106,9 @@ filter Get-GitHubAssignee
 filter Test-GitHubAssignee
 {
 <#
+    .SYNOPSIS
+        Checks if a user has permission to be assigned to an issue in this repository.
+
     .DESCRIPTION
         Checks if a user has permission to be assigned to an issue in this repository.
 
@@ -230,6 +236,9 @@ filter Test-GitHubAssignee
 function Add-GitHubAssignee
 {
 <#
+    .SYNOPSIS
+       Adds a list of assignees to a GitHub Issue for the given repository.
+
     .DESCRIPTION
        Adds a list of assignees to a GitHub Issue for the given repository.
 
@@ -415,6 +424,9 @@ function Add-GitHubAssignee
 function Remove-GitHubAssignee
 {
 <#
+    .SYNOPSIS
+        Removes an assignee from a GitHub issue.
+
     .DESCRIPTION
         Removes an assignee from a GitHub issue.
 

diff --git a/GitHubCore.ps1 b/GitHubCore.ps1
@@ -1046,8 +1046,11 @@ filter ConvertTo-SmarterObject
 function Get-MediaAcceptHeader
 {
 <#
+    .SYNOPSIS
+        Returns a formatted AcceptHeader based on the requested MediaType.
+
     .DESCRIPTION
-        Returns a formatted AcceptHeader based on the requested MediaType
+        Returns a formatted AcceptHeader based on the requested MediaType.
 
         The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
 

diff --git a/GitHubEvents.ps1 b/GitHubEvents.ps1
@@ -10,8 +10,11 @@
 filter Get-GitHubEvent
 {
 <#
+    .SYNOPSIS
+        Lists events for an issue, repository, or a single event.
+
     .DESCRIPTION
-        Lists events for an issue, repository, or a single event
+        Lists events for an issue, repository, or a single event.
 
         The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
 

diff --git a/GitHubIssueComments.ps1 b/GitHubIssueComments.ps1
@@ -11,6 +11,9 @@
 filter Get-GitHubIssueComment
 {
 <#
+    .SYNOPSIS
+        Get the Issue comments for a given GitHub repository.
+
     .DESCRIPTION
         Get the Issue comments for a given GitHub repository.
 
@@ -279,8 +282,11 @@ filter Get-GitHubIssueComment
 filter New-GitHubIssueComment
 {
 <#
+    .SYNOPSIS
+        Creates a new GitHub comment for an issue for the given repository.
+
     .DESCRIPTION
-        Creates a new GitHub comment for an issue for the given repository
+        Creates a new GitHub comment for an issue for the given repository.
 
         The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
 
@@ -414,8 +420,11 @@ filter New-GitHubIssueComment
 filter Set-GitHubIssueComment
 {
 <#
+    .SYNOPSIS
+        Modifies an existing comment in an issue for the given repository.
+
     .DESCRIPTION
-        Modifies an existing comment in an issue for the given repository
+        Modifies an existing comment in an issue for the given repository.
 
         The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
 
@@ -565,8 +574,11 @@ filter Set-GitHubIssueComment
 filter Remove-GitHubIssueComment
 {
 <#
+    .SYNOPSIS
+        Deletes a GitHub comment from an Issue in the given repository.
+
     .DESCRIPTION
-        Deletes a GitHub comment from an Issue in the given repository
+        Deletes a GitHub comment from an Issue in the given repository.
 
         The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
 

diff --git a/GitHubLabels.ps1 b/GitHubLabels.ps1
@@ -795,6 +795,9 @@ filter Initialize-GitHubLabel
 function Add-GitHubIssueLabel
 {
 <#
+    .SYNOPSIS
+        Adds a label to an issue in the given GitHub repository.
+
     .DESCRIPTION
         Adds a label to an issue in the given GitHub repository.
 
@@ -960,6 +963,9 @@ function Add-GitHubIssueLabel
 function Set-GitHubIssueLabel
 {
 <#
+    .SYNOPSIS
+        Replaces labels on an issue in the given GitHub repository.
+
     .DESCRIPTION
         Replaces labels on an issue in the given GitHub repository.
 
@@ -1159,6 +1165,9 @@ function Set-GitHubIssueLabel
 filter Remove-GitHubIssueLabel
 {
 <#
+    .SYNOPSIS
+        Deletes a label from an issue in the given GitHub repository.
+
     .DESCRIPTION
         Deletes a label from an issue in the given GitHub repository.
 

diff --git a/GitHubMilestones.ps1 b/GitHubMilestones.ps1
@@ -14,6 +14,9 @@ $script:minimumHoursToEnsureDesiredDateInPacificTime = 9
 filter Get-GitHubMilestone
 {
 <#
+    .SYNOPSIS
+        Get the milestones for a given GitHub repository.
+
     .DESCRIPTION
         Get the milestones for a given GitHub repository.
 
@@ -205,8 +208,11 @@ filter Get-GitHubMilestone
 filter New-GitHubMilestone
 {
 <#
+    .SYNOPSIS
+        Creates a new GitHub milestone for the given repository.
+
     .DESCRIPTION
-        Creates a new GitHub milestone for the given repository
+        Creates a new GitHub milestone for the given repository.
 
         The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
 
@@ -380,8 +386,11 @@ filter New-GitHubMilestone
 filter Set-GitHubMilestone
 {
 <#
+    .SYNOPSIS
+        Update an existing milestone for the given repository.
+
     .DESCRIPTION
-        Update an existing milestone for the given repository
+        Update an existing milestone for the given repository.
 
         The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
 
@@ -579,8 +588,11 @@ filter Set-GitHubMilestone
 filter Remove-GitHubMilestone
 {
 <#
+    .SYNOPSIS
+        Deletes a GitHub milestone for the given repository.
+
     .DESCRIPTION
-        Deletes a GitHub milestone for the given repository
+        Deletes a GitHub milestone for the given repository.
 
         The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
 

diff --git a/GitHubProjectCards.ps1 b/GitHubProjectCards.ps1
@@ -10,6 +10,9 @@
 filter Get-GitHubProjectCard
 {
 <#
+    .SYNOPSIS
+        Get the cards for a given GitHub Project Column.
+
     .DESCRIPTION
         Get the cards for a given GitHub Project Column.
 
@@ -124,6 +127,9 @@ filter Get-GitHubProjectCard
 filter New-GitHubProjectCard
 {
 <#
+    .SYNOPSIS
+        Creates a new card for a GitHub project.
+
     .DESCRIPTION
         Creates a new card for a GitHub project.
 
@@ -260,6 +266,9 @@ filter New-GitHubProjectCard
 filter Set-GitHubProjectCard
 {
 <#
+    .SYNOPSIS
+        Modify a GitHub Project Card.
+
     .DESCRIPTION
         Modify a GitHub Project Card.
 
@@ -386,6 +395,9 @@ filter Set-GitHubProjectCard
 filter Remove-GitHubProjectCard
 {
 <#
+    .SYNOPSIS
+        Removes a project card.
+
     .DESCRIPTION
         Removes a project card.
 
@@ -468,6 +480,9 @@ filter Remove-GitHubProjectCard
 filter Move-GitHubProjectCard
 {
 <#
+    .SYNOPSIS
+        Move a GitHub Project Card.
+
     .DESCRIPTION
         Move a GitHub Project Card.
 

diff --git a/GitHubProjectColumns.ps1 b/GitHubProjectColumns.ps1
@@ -10,6 +10,9 @@
 filter Get-GitHubProjectColumn
 {
 <#
+    .SYNOPSIS
+        Get the columns for a given GitHub Project.
+
     .DESCRIPTION
         Get the columns for a given GitHub Project.
 
@@ -101,6 +104,9 @@ filter Get-GitHubProjectColumn
 filter New-GitHubProjectColumn
 {
 <#
+    .SYNOPSIS
+        Creates a new column for a GitHub project.
+
     .DESCRIPTION
         Creates a new column for a GitHub project.
 
@@ -183,6 +189,9 @@ filter New-GitHubProjectColumn
 filter Set-GitHubProjectColumn
 {
 <#
+    .SYNOPSIS
+        Modify a GitHub Project Column.
+
     .DESCRIPTION
         Modify a GitHub Project Column.
 
@@ -271,6 +280,9 @@ filter Set-GitHubProjectColumn
 filter Remove-GitHubProjectColumn
 {
 <#
+    .SYNOPSIS
+        Removes the column for a project.
+
     .DESCRIPTION
         Removes the column for a project.
 
@@ -354,6 +366,9 @@ filter Remove-GitHubProjectColumn
 filter Move-GitHubProjectColumn
 {
 <#
+    .SYNOPSIS
+        Move a GitHub Project Column.
+
     .DESCRIPTION
         Move a GitHub Project Column.
 

diff --git a/GitHubProjects.ps1 b/GitHubProjects.ps1
@@ -10,6 +10,9 @@
 filter Get-GitHubProject
 {
 <#
+    .SYNOPSIS
+        Get the projects for a given GitHub user, repository or organization.
+
     .DESCRIPTION
         Get the projects for a given GitHub user, repository or organization.
 
@@ -212,8 +215,11 @@ filter Get-GitHubProject
 filter New-GitHubProject
 {
 <#
+    .SYNOPSIS
+        Creates a new GitHub project for the given repository.
+
     .DESCRIPTION
-        Creates a new GitHub project for the given repository
+        Creates a new GitHub project for the given repository.
 
         The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
 
@@ -395,6 +401,9 @@ filter New-GitHubProject
 filter Set-GitHubProject
 {
 <#
+    .SYNOPSIS
+        Modify a GitHub Project.
+
     .DESCRIPTION
         Modify a GitHub Project.
 
@@ -543,6 +552,9 @@ filter Set-GitHubProject
 filter Remove-GitHubProject
 {
 <#
+    .SYNOPSIS
+        Removes the projects for a given GitHub repository.
+
     .DESCRIPTION
         Removes the projects for a given GitHub repository.