Add Outputs for GitHubReference methods

microsoft · Mar 24, 2019 · 50585d7 · 50585d7
1 parent 5e3c7d9
commit 50585d7
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/GitHubReferences.ps1 b/GitHubReferences.ps1
@@ -36,6 +36,10 @@ function Get-GitHubReference
         with no commandline status update.  When not specified, those commands run in
         the background, enabling the command prompt to provide status information.
         If not supplied here, the DefaultNoStatus configuration property value will be used.
+    
+    .OUTPUTS
+        [PSCustomObject]
+        Details of the git reference in the given repository
 
     .EXAMPLE
         Get-GitHubReference -OwnerName Powershell -RepositoryName PowerShellForGitHub -Reference heads/master
@@ -147,6 +151,10 @@ function New-GitHubReference
         the background, enabling the command prompt to provide status information.
         If not supplied here, the DefaultNoStatus configuration property value will be used.
 
+    .OUTPUTS
+    [PSCustomObject]
+    Details of the git reference created. Throws an Exception if the reference already exists
+
     .EXAMPLE
         -GitHubReference -OwnerName Powershell -RepositoryName PowerShellForGitHub -Reference refs/heads/master -Sha aa218f56b14c9653891f9e74264a383fa43fefbd
     #>