Skip to content

Commit 21cbd76

Browse files
committed
Adding function documentation
1 parent 5dde8fa commit 21cbd76

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

GitHubAnalytics.psm1

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -971,6 +971,19 @@ function Get-GitHubOrganizationRepository
971971
return $resultToReturn
972972
}
973973

974+
<#
975+
.SYNOPSIS Function which gets a list of branches for a given repository
976+
.PARAM
977+
owner The name of the repository owner
978+
.PARAM
979+
repository The name of the repository
980+
.PARAM
981+
gitHubAccessToken GitHub API Access Token.
982+
Get github token from https://github.com/settings/tokens
983+
If you don't provide it, you can still use this script, but you will be limited to 60 queries per hour.
984+
.EXAMPLE
985+
$branches = Get-GitHubRepositoryBranch -owner PowerShell -repository PowerShellForGitHub
986+
#>
974987
function Get-GitHubRepositoryBranch
975988
{
976989
param

0 commit comments

Comments
 (0)