Commit03a158a

committed

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

1 parent63502d1 commit03a158aCopy full SHA for 03a158a

File tree

+33

-3

lines changed

+33

-3

lines changed

Lines changed: 16 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,22 @@ Pull Requests leverage [these](#custom-mime-types) custom mime types. You`
`8`	`8`	`can read more about the use of mime types in the API`
`9`	`9`	`[here](/v3/mime/).`
`10`	`10`
	`11`	`+##Link Relations`
	`12`	`+`
	`13`	`+Pull Requests have these possible link relations:`
	`14`	`+`
	`15`	+`self`
	`16`	`+: The API location of this Pull Request.`
	`17`	`+`
	`18`	+`html`
	`19`	`+: The HTML location of this Pull Request.`
	`20`	`+`
	`21`	+`comments`
	`22`	`+: The API location of this Pull Request's Issue comments.`
	`23`	`+`
	`24`	+`review_comments`
	`25`	`+: The API location of this Pull Request's Review comments.`
	`26`	`+`
`11`	`27`	`##List pull requests`
`12`	`28`
`13`	`29`	`GET /repos/:user/:repo/pulls`

Lines changed: 7 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,14 @@`
`2`	`2`	`title:Pull Request Comments \| GitHub API`
`3`	`3`	`---`
`4`	`4`
`5`		`-#Pull Request Comments API`
	`5`	`+#Pull RequestReviewComments API`
`6`	`6`
`7`		`-Pull Request Comments leverage[these](#custom-mime-types) custom mime`
	`7`	`+Pull Request Review Comments are comments on a portion of the unified`
	`8`	`+diff. These are separate from Commit Comments (which are applied`
	`9`	`+directly to a commit, outside of the Pull Request view), and Issue`
	`10`	`+Comments (which do not reference a portion of the unified diff).`
	`11`	`+`
	`12`	`+Pull Request Review Comments leverage[these](#custom-mime-types) custom mime`
`8`	`13`	`types. You can read more about the use of mime types in the API`
`9`	`14`	`[here](/v3/mime/).`
`10`	`15`

Lines changed: 10 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,6 @@ def json(key)`
`150`	`150`	`}`
`151`	`151`	`}`
`152`	`152`
`153`		`-`
`154`	`153`	`PULL={`
`155`	`154`	`"url"=>"https://api.github.com/octocat/Hello-World/pulls/1",`
`156`	`155`	`"html_url"=>"https://github.com/octocat/Hello-World/pulls/1",`
`@@ -165,6 +164,16 @@ def json(key)`
`165`	`164`	`"updated_at"=>"2011-01-26T19:01:12Z",`
`166`	`165`	`"closed_at"=>"2011-01-26T19:01:12Z",`
`167`	`166`	`"merged_at"=>"2011-01-26T19:01:12Z",`
	`167`	`+"_links"=>{`
	`168`	`+"self"=>{'_href'=>`
	`169`	`+"https://api.github.com/octocat/Hello-World/pulls/1"},`
	`170`	`+"html"=>{'_href'=>`
	`171`	`+"https://github.com/octocat/Hello-World/pull/1"},`
	`172`	`+"comments"=>{'_href'=>`
	`173`	`+"https://api.github.com/octocat/Hello-World/issues/1/comments"},`
	`174`	`+"review_comments"=>{'_href'=>`
	`175`	`+"https://api.github.com/octocat/Hello-World/pulls/1/comments"}`
	`176`	`+}`
`168`	`177`	`}`
`169`	`178`
`170`	`179`	`FULL_PULL=PULL.merge({`

Comments

(0)