try to clarify the difference between pull request comments and review comments

technoweenie · technoweenie · commit 03a158a2ee76 · 2011-10-26T09:14:46.000-06:00
diff --git a/content/v3/pulls.md b/content/v3/pulls.md
@@ -8,6 +8,22 @@ Pull Requests leverage [these](#custom-mime-types) custom mime types. You
 can read more about the use of mime types in the API
 [here](/v3/mime/).
 
+## Link Relations
+
+Pull Requests have these possible link relations:
+
+`self`
+: The API location of this Pull Request.
+
+`html`
+: The HTML location of this Pull Request.
+
+`comments`
+: The API location of this Pull Request's Issue comments.
+
+`review_comments`
+: The API location of this Pull Request's Review comments.
+
 ## List pull requests
 
     GET /repos/:user/:repo/pulls
diff --git a/content/v3/pulls/comments.md b/content/v3/pulls/comments.md
@@ -2,9 +2,14 @@
 title: Pull Request Comments | GitHub API
 ---
 
-# Pull Request Comments API
+# Pull Request Review Comments API
 
-Pull Request Comments leverage [these](#custom-mime-types) custom mime
+Pull Request Review Comments are comments on a portion of the unified
+diff.  These are separate from Commit Comments (which are applied
+directly to a commit, outside of the Pull Request view), and Issue
+Comments (which do not reference a portion of the unified diff).  
+
+Pull Request Review Comments leverage [these](#custom-mime-types) custom mime
 types. You can read more about the use of mime types in the API
 [here](/v3/mime/).
 
diff --git a/lib/resources.rb b/lib/resources.rb
@@ -150,7 +150,6 @@ def json(key)
       }
     }
 
-
     PULL = {
       "url"        => "https://api.github.com/octocat/Hello-World/pulls/1",
       "html_url"   => "https://github.com/octocat/Hello-World/pulls/1",
@@ -165,6 +164,16 @@ def json(key)
       "updated_at" => "2011-01-26T19:01:12Z",
       "closed_at"  => "2011-01-26T19:01:12Z",
       "merged_at"  => "2011-01-26T19:01:12Z",
+      "_links" => {
+        "self" => {'_href' =>
+          "https://api.github.com/octocat/Hello-World/pulls/1"},
+        "html" => {'_href' =>
+          "https://github.com/octocat/Hello-World/pull/1"},
+        "comments" => {'_href' =>
+          "https://api.github.com/octocat/Hello-World/issues/1/comments"},
+        "review_comments" => {'_href' =>
+          "https://api.github.com/octocat/Hello-World/pulls/1/comments"}
+      }
     }
 
     FULL_PULL = PULL.merge({
