From 64bd9d4b9b8cba6c9fa0c554bf72cce9250659d2 Mon Sep 17 00:00:00 2001
From: Peter MacNaughton <peter@macnaughton.info>
Date: Wed, 26 Feb 2014 22:08:46 -0700
Subject: [PATCH] Updating some interface documentation

where the implementation documentation seemed better.
---
 .../Clients/IObservableIssueCommentsClient.cs      | 14 +++++++-------
 .../Clients/IObservableMilestonesClient.cs         |  4 ++--
 .../Clients/IObservableStarredClient.cs            |  2 +-
 3 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs b/Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs
index 401391db..c6c6a67d 100644
--- a/Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs
+++ b/Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs
@@ -12,8 +12,8 @@ namespace Octokit.Reactive
         /// <remarks>http://developer.github.com/v3/issues/comments/#get-a-single-comment</remarks>
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
-        /// <param name="number">The issue number</param>
-        /// <returns></returns>
+        /// <param name="number">The issue comment number</param>
+        /// <returns>The <see cref="IssueComment"/>s for the specified Issue Comment.</returns>
         [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
             Justification = "Method makes a network request")]
         IObservable<IssueComment> Get(string owner, string name, int number);
@@ -24,7 +24,7 @@ namespace Octokit.Reactive
         /// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository</remarks>
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
-        /// <returns></returns>
+        /// <returns>The list of <see cref="IssueComment"/>s for the specified Repository.</returns>
         IObservable<IssueComment> GetForRepository(string owner, string name);
 
         /// <summary>
@@ -34,7 +34,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 issue number</param>
-        /// <returns></returns>
+        /// <returns>The list of <see cref="IssueComment"/>s for the specified Issue.</returns>
         IObservable<IssueComment> GetForIssue(string owner, string name, int number);
 
         /// <summary>
@@ -44,8 +44,8 @@ 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 number of the issue</param>
-        /// <param name="newComment">The new comment to add to the issue</param>
-        /// <returns></returns>
+        /// <param name="newComment">The text of the new comment</param>
+        /// <returns>The <see cref="IssueComment"/> that was just created.</returns>
         IObservable<IssueComment> Create(string owner, string name, int number, string newComment);
 
         /// <summary>
@@ -56,7 +56,7 @@ namespace Octokit.Reactive
         /// <param name="name">The name of the repository</param>
         /// <param name="number">The comment number</param>
         /// <param name="commentUpdate">The modified comment</param>
-        /// <returns></returns>
+        /// <returns>The <see cref="IssueComment"/> that was just updated.</returns>
         IObservable<IssueComment> Update(string owner, string name, int number, string commentUpdate);
 
         /// <summary>
diff --git a/Octokit.Reactive/Clients/IObservableMilestonesClient.cs b/Octokit.Reactive/Clients/IObservableMilestonesClient.cs
index f1ad38e3..c21ef819 100644
--- a/Octokit.Reactive/Clients/IObservableMilestonesClient.cs
+++ b/Octokit.Reactive/Clients/IObservableMilestonesClient.cs
@@ -41,7 +41,7 @@ namespace Octokit.Reactive
         IObservable<Milestone> GetForRepository(string owner, string name, MilestoneRequest request);
 
         /// <summary>
-        /// Creates a milestone for the specified repository. Any user with pull access to a repository can create an
+        /// Creates a milestone for the specified repository. Any user with pull access to a repository can create a
         /// Milestone.
         /// </summary>
         /// <remarks>http://developer.github.com/v3/issues/milestones/#create-a-milestone</remarks>
@@ -52,7 +52,7 @@ namespace Octokit.Reactive
         IObservable<Milestone> Create(string owner, string name, NewMilestone newMilestone);
 
         /// <summary>
-        /// Creates a milestone for the specified repository. Any user with pull access to a repository can create an
+        /// Updates a milestone for the specified repository. Any user with pull access to a repository can create a
         /// Milestone.
         /// </summary>
         /// <remarks>http://developer.github.com/v3/issues/milestones/#update-a-milestone</remarks>
diff --git a/Octokit.Reactive/Clients/IObservableStarredClient.cs b/Octokit.Reactive/Clients/IObservableStarredClient.cs
index 382260c9..63dd4e35 100644
--- a/Octokit.Reactive/Clients/IObservableStarredClient.cs
+++ b/Octokit.Reactive/Clients/IObservableStarredClient.cs
@@ -10,7 +10,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <exception cref="AuthorizationException">Thrown if the client is not authenticated</exception>
-        /// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/> starring the passed repository</returns>
+        /// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s starring the passed repository</returns>
         IObservable<User> GetAllStargazers(string owner, string name);
 
         /// <summary>