From 93b8b27a0b23d952d799845dc4a71e118d899ef7 Mon Sep 17 00:00:00 2001
From: Brendan Forster <brendan@github.com>
Date: Tue, 18 Feb 2014 19:48:51 +1100
Subject: [PATCH] updated docs

---
 .../Clients/IObservablePullRequestsClient.cs   | 18 +++++++++---------
 .../Clients/ObservablePullRequestsClient.cs    | 16 ++++++++--------
 Octokit/Clients/IPullRequestsClient.cs         |  4 ++--
 Octokit/Clients/PullRequestsClient.cs          |  4 ++--
 4 files changed, 21 insertions(+), 21 deletions(-)

diff --git a/Octokit.Reactive/Clients/IObservablePullRequestsClient.cs b/Octokit.Reactive/Clients/IObservablePullRequestsClient.cs
index 0e608964..4d49adbd 100644
--- a/Octokit.Reactive/Clients/IObservablePullRequestsClient.cs
+++ b/Octokit.Reactive/Clients/IObservablePullRequestsClient.cs
@@ -11,7 +11,7 @@ namespace Octokit.Reactive
         /// <remarks>
         /// http://developer.github.com/v3/pulls/#get-a-single-pull-request
         /// </remarks>
-        /// <returns></returns>
+        /// <returns>A <see cref="PullRequest"/> result</returns>
         [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
         Justification = "Method makes a network request")]
         IObservable<PullRequest> Get(string owner, string name, int number);
@@ -24,11 +24,11 @@ namespace Octokit.Reactive
         /// </remarks>
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
-        /// <returns></returns>
+        /// <returns>A collection of <see cref="PullRequest"/> results</returns>
         IObservable<PullRequest> GetForRepository(string owner, string name);
 
         /// <summary>
-        /// Gets all open pull requests for the repository.
+        /// Query pull requests for the repository based on criteria
         /// </summary>
         /// <remarks>
         /// http://developer.github.com/v3/pulls/#list-pull-requests
@@ -36,7 +36,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="request">Used to filter and sort the list of pull requests returned</param>
-        /// <returns></returns>
+        /// <returns>A collection of <see cref="PullRequest"/> results</returns>
         IObservable<PullRequest> GetForRepository(string owner, string name, PullRequestRequest request);
 
         /// <summary>
@@ -46,7 +46,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
-        /// <returns></returns>
+        /// <returns>A created <see cref="PullRequest"/> result</returns>
         IObservable<PullRequest> Create(string owner, string name, NewPullRequest newPullRequest);
 
         /// <summary>
@@ -58,7 +58,7 @@ namespace Octokit.Reactive
         /// <param name="number">The PullRequest number</param>
         /// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
         /// </param>
-        /// <returns></returns>
+        /// <returns>An updated <see cref="PullRequest"/> result</returns>
         IObservable<PullRequest> Update(string owner, string name, int number, PullRequestUpdate pullRequestUpdate);
 
         /// <summary>
@@ -69,7 +69,7 @@ namespace Octokit.Reactive
         /// <param name="name">The name of the repository</param>
         /// <param name="number">The pull request number</param>
         /// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="PullRequestMerge"/> result</returns>
         IObservable<PullRequestMerge> Merge(string owner, string name, int number, MergePullRequest mergePullRequest);
 
         /// <summary>
@@ -79,7 +79,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="number">The pull request number</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="bool"/> result - true if the pull request has been merged, false otherwise</returns>
         IObservable<bool> Merged(string owner, string name, int number);
 
         /// <summary>
@@ -89,7 +89,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="number">The pull request number</param>
-        /// <returns></returns>
+        /// <returns>A collection of <see cref="Commit"/> results</returns>
         IObservable<Commit> Commits(string owner, string name, int number);
     }
 }
diff --git a/Octokit.Reactive/Clients/ObservablePullRequestsClient.cs b/Octokit.Reactive/Clients/ObservablePullRequestsClient.cs
index 6065825c..343a70a6 100644
--- a/Octokit.Reactive/Clients/ObservablePullRequestsClient.cs
+++ b/Octokit.Reactive/Clients/ObservablePullRequestsClient.cs
@@ -23,7 +23,7 @@ namespace Octokit.Reactive
         /// <remarks>
         /// http://developer.github.com/v3/pulls/#get-a-single-pull-request
         /// </remarks>
-        /// <returns></returns>
+        /// <returns>A <see cref="PullRequest"/> result</returns>
         public IObservable<PullRequest> Get(string owner, string name, int number)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -40,7 +40,7 @@ namespace Octokit.Reactive
         /// </remarks>
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
-        /// <returns></returns>
+        /// <returns>A collection of <see cref="PullRequest"/> results</returns>
         public IObservable<PullRequest> GetForRepository(string owner, string name)
         {
             return _connection.GetAndFlattenAllPages<PullRequest>(ApiUrls.PullRequests(owner, name));
@@ -55,7 +55,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="request">Used to filter the list of Pull Requests returned</param>
-        /// <returns></returns>
+        /// <returns>A collection of <see cref="PullRequest"/> results</returns>
         public IObservable<PullRequest> GetForRepository(string owner, string name, PullRequestRequest request)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -73,7 +73,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
-        /// <returns></returns>
+        /// <returns>A created <see cref="PullRequest"/> result</returns>
         public IObservable<PullRequest> Create(string owner, string name, NewPullRequest newPullRequest)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -92,7 +92,7 @@ namespace Octokit.Reactive
         /// <param name="number">The PullRequest number</param>
         /// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
         /// </param>
-        /// <returns></returns>
+        /// <returns>An updated <see cref="PullRequest"/> result</returns>
         public IObservable<PullRequest> Update(string owner, string name, int number, PullRequestUpdate pullRequestUpdate)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -110,7 +110,7 @@ namespace Octokit.Reactive
         /// <param name="name">The name of the repository</param>
         /// <param name="number">The pull request number</param>
         /// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="PullRequestMerge"/> result</returns>
         public IObservable<PullRequestMerge> Merge(string owner, string name, int number, MergePullRequest mergePullRequest) 
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -127,7 +127,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="number">The pull request number</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="bool"/> result - true if the pull request has been merged, false otherwise</returns>
         public IObservable<bool> Merged(string owner, string name, int number) 
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -143,7 +143,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="number">The pull request number</param>
-        /// <returns></returns>
+        /// <returns>A collection of <see cref="Commit"/> results</returns>
         public IObservable<Commit> Commits(string owner, string name, int number) 
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
diff --git a/Octokit/Clients/IPullRequestsClient.cs b/Octokit/Clients/IPullRequestsClient.cs
index d64dfd2b..29211f06 100644
--- a/Octokit/Clients/IPullRequestsClient.cs
+++ b/Octokit/Clients/IPullRequestsClient.cs
@@ -12,7 +12,7 @@ namespace Octokit
         /// <remarks>
         /// http://developer.github.com/v3/pulls/#get-a-single-pull-request
         /// </remarks>
-        /// <returns></returns>
+        /// <returns>A <see cref="PullRequest"/> result</returns>
         [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
         Justification = "Method makes a network request")]
         Task<PullRequest> Get(string owner, string name, int number);
@@ -29,7 +29,7 @@ namespace Octokit
         Task<IReadOnlyList<PullRequest>> GetForRepository(string owner, string name);
 
         /// <summary>
-        /// Get pull requests for the repository based on a given criteria
+        /// Query pull requests for the repository based on criteria
         /// </summary>
         /// <remarks>
         /// http://developer.github.com/v3/pulls/#list-pull-requests
diff --git a/Octokit/Clients/PullRequestsClient.cs b/Octokit/Clients/PullRequestsClient.cs
index a616b992..1fc23ed6 100644
--- a/Octokit/Clients/PullRequestsClient.cs
+++ b/Octokit/Clients/PullRequestsClient.cs
@@ -17,7 +17,7 @@ namespace Octokit
         /// <remarks>
         /// http://developer.github.com/v3/pulls/#get-a-single-pull-request
         /// </remarks>
-        /// <returns></returns>
+        /// <returns>A <see cref="PullRequest"/> result</returns>
         public Task<PullRequest> Get(string owner, string name, int number)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -41,7 +41,7 @@ namespace Octokit
         }
 
         /// <summary>
-        /// Get pull requests for the repository based on a given criteria
+        /// Query pull requests for the repository based on criteria
         /// </summary>
         /// <remarks>
         /// http://developer.github.com/v3/pulls/#list-pull-requests