Skip to content

Commit eb8e941

Browse files
authored
Unify language in the API docs for commits (github#33369)
1 parent 7da39b4 commit eb8e941

File tree

4 files changed

+10
-11
lines changed

4 files changed

+10
-11
lines changed

content/rest/commits/comments.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Commit comments
3-
intro: The Commit comments API lets you create and edit comments that relate to specific commits.
3+
intro: Use the REST API to interact with commit comments.
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -12,9 +12,9 @@ miniTocMaxHeadingLevel: 3
1212
allowTitleToDifferFromFilename: true
1313
---
1414

15-
## About the commit comments API
15+
## About commit comments
1616

17-
The Commit comments API lets you create and edit comments that relate to specific commits.
17+
You can create, edit, and view commit comments using the REST API. A commit comment is a comment made on a specfic commit. For more information, see "[Working with comments](/rest/guides/working-with-comments#commit-comments)."
1818

1919
### Custom media types for commit comments
2020

content/rest/commits/commits.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Commits
3-
intro: 'The Commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.'
3+
intro: 'Use the REST API to interact with commits.'
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -10,4 +10,3 @@ topics:
1010
- API
1111
miniTocMaxHeadingLevel: 3
1212
---
13-

content/rest/commits/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Commits
3-
intro: 'The commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.'
3+
intro: 'Use the REST API to interact with commits.'
44
allowTitleToDifferFromFilename: true
55
versions:
66
fpt: '*'

content/rest/commits/statuses.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Commit statuses
3-
intro: 'The Commit status API allows external services to mark commits with a status, which is then reflected in pull requests involving those commits.'
3+
intro: 'Use the REST API to interact with commit statuses.'
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -12,14 +12,14 @@ miniTocMaxHeadingLevel: 3
1212
allowTitleToDifferFromFilename: true
1313
---
1414

15-
## About the Commit statuses API
15+
## About commit statuses
1616

17-
The Commit status API allows external services to mark commits with an `error`, `failure`, `pending`, or `success` state, which is then reflected in pull requests involving those commits. 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.
17+
You can use the REST API to allow external services to mark commits with an `error`, `failure`, `pending`, or `success` state, which is then reflected in pull requests involving those commits. 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.
1818

1919
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 build.
2020

21-
Statuses can include a `context` to indicate what service is providing that status. For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can then use the [Get the combined status for a specific reference](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit.
21+
Statuses can include a `context` to indicate what service is providing that status. For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can then use the REST API to [Get the combined status for a specific reference](/rest/commits/statuses#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit.
2222

2323
Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the `repo` scope grants permission to code as well as statuses.
2424

25-
If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the [Checks API](/rest/reference/checks).
25+
If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the REST API to manage checks. For more information, see "[Checks](/rest/reference/checks)."

0 commit comments

Comments
 (0)