Skip to content

Commit 0d1b705

Browse files
authored
update intros (#27297)
1 parent e7b5b77 commit 0d1b705

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

content/rest/commits/comments.md

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

15+
## About the commit comments API
16+
17+
The Commit comments API lets you create and edit comments that relate to specific commits.
18+
1519
### Custom media types for commit comments
1620

1721
These are the supported media types for commit comments. You can read more

content/rest/commits/statuses.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Commit statuses
3-
intro: 'The 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.'
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.'
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -12,7 +12,9 @@ miniTocMaxHeadingLevel: 3
1212
allowTitleToDifferFromFilename: true
1313
---
1414

15-
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.
15+
## About the Commit statuses API
16+
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.
1618

1719
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.
1820

0 commit comments

Comments
 (0)