Skip to content

Add missing .SYNOPSIS to functions #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HowardWolosky merged 1 commit into from
Oct 5, 2020
Merged

Add missing .SYNOPSIS to functions #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions GitHubAssignees.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
5 changes: 4 additions & 1 deletion GitHubCore.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 4 additions & 1 deletion GitHubEvents.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
18 changes: 15 additions & 3 deletions GitHubIssueComments.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
9 changes: 9 additions & 0 deletions GitHubLabels.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
18 changes: 15 additions & 3 deletions GitHubMilestones.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
15 changes: 15 additions & 0 deletions GitHubProjectCards.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -260,6 +266,9 @@ filter New-GitHubProjectCard
filter Set-GitHubProjectCard
{
<#
.SYNOPSIS
Modify a GitHub Project Card.

.DESCRIPTION
Modify a GitHub Project Card.

Expand Down Expand Up @@ -386,6 +395,9 @@ filter Set-GitHubProjectCard
filter Remove-GitHubProjectCard
{
<#
.SYNOPSIS
Removes a project card.

.DESCRIPTION
Removes a project card.

Expand Down Expand Up @@ -468,6 +480,9 @@ filter Remove-GitHubProjectCard
filter Move-GitHubProjectCard
{
<#
.SYNOPSIS
Move a GitHub Project Card.

.DESCRIPTION
Move a GitHub Project Card.

Expand Down
15 changes: 15 additions & 0 deletions GitHubProjectColumns.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -183,6 +189,9 @@ filter New-GitHubProjectColumn
filter Set-GitHubProjectColumn
{
<#
.SYNOPSIS
Modify a GitHub Project Column.

.DESCRIPTION
Modify a GitHub Project Column.

Expand Down Expand Up @@ -271,6 +280,9 @@ filter Set-GitHubProjectColumn
filter Remove-GitHubProjectColumn
{
<#
.SYNOPSIS
Removes the column for a project.

.DESCRIPTION
Removes the column for a project.

Expand Down Expand Up @@ -354,6 +366,9 @@ filter Remove-GitHubProjectColumn
filter Move-GitHubProjectColumn
{
<#
.SYNOPSIS
Move a GitHub Project Column.

.DESCRIPTION
Move a GitHub Project Column.

Expand Down
14 changes: 13 additions & 1 deletion GitHubProjects.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -395,6 +401,9 @@ filter New-GitHubProject
filter Set-GitHubProject
{
<#
.SYNOPSIS
Modify a GitHub Project.

.DESCRIPTION
Modify a GitHub Project.

Expand Down Expand Up @@ -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.

Expand Down