diff --git a/content/v3/repos/statuses.md b/content/v3/repos/statuses.md index 1913e9463f..6e4176b1da 100644 --- a/content/v3/repos/statuses.md +++ b/content/v3/repos/statuses.md @@ -11,14 +11,14 @@ The Status API allows external services to mark commits with a success, failure, error, or pending `state`, which is then reflected in pull requests involving those commits. -Statuses can also include an optional `description` and `url`, and +Statuses can also include an optional `description` and `target_url`, and we highly recommend providing them as they make statuses much more useful in the GitHub UI. As an example, one common use is for continuous integration services to mark commits as passing or failing builds using Status. The `target_url` would be the full url to the build output, and the -description would be the high level summary of what happened with the +`description` would be the high level summary of what happened with the build. Note that the `repo:status` [OAuth scope](/v3/oauth/#scopes) grants targeted
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: