diff --git a/Get-GitPullRequestLocal/Get-GitPullRequestLocal.ps1 b/Get-GitPullRequestLocal/Get-GitPullRequestLocal.ps1 index b97a82f..ef18f08 100644 --- a/Get-GitPullRequestLocal/Get-GitPullRequestLocal.ps1 +++ b/Get-GitPullRequestLocal/Get-GitPullRequestLocal.ps1 @@ -3,6 +3,9 @@ Function Get-GitPullRequestLocal { .SYNOPSIS Helper function that creates folder, clones single branch based of a GitHub pull request uri +.DESCRIPTION +This function is created to simplify working with pull requests. In order to get all the files on tbe local system in an organized method, I decided to group together these commands. + .EXAMPLE Get-GitPullRequestLocal -Uri https://github.com/jaapbrasser/SharedScripts/pull/29 @@ -37,4 +40,4 @@ Will create a folder in C:\Temp named after the PR number, and clone the specifi # Retrieve status of the current branch git status } catch {} -} \ No newline at end of file +}