Commit13e5a04

committed

Fix URL parameter name

Add 'description' to code block.

1 parentfcd6553 commit13e5a04Copy full SHA for 13e5a04

File tree

-2

lines changed

-2

lines changed

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -11,14 +11,14 @@ The Status API allows external services to mark commits with a success,`
`11`	`11`	failure, error, or pending`state`, which is then reflected in pull requests
`12`	`12`	`involving those commits.`
`13`	`13`
`14`		-Statuses can also include an optional`description` and`url`, and
	`14`	+Statuses can also include an optional`description` and`target_url`, and
`15`	`15`	`we highly recommend providing them as they make statuses much more`
`16`	`16`	`useful in the GitHub UI.`
`17`	`17`
`18`	`18`	`As an example, one common use is for continuous integration`
`19`	`19`	`services to mark commits as passing or failing builds using Status. The`
`20`	`20`	`target_url` would be the full url to the build output, and the
`21`		`-description would be the high level summary of what happened with the`
	`21`	+`description` would be the high level summary of what happened with the
`22`	`22`	`build.`
`23`	`23`
`24`	`24`	Note that the`repo:status`[OAuth scope](/v3/oauth/#scopes) grants targeted

Comments

(0)