Skip to content

Commit 7467f92

Browse files
Commit via running ake Sources/pulls
1 parent 9df62b2 commit 7467f92

File tree

2 files changed

+24
-24
lines changed

2 files changed

+24
-24
lines changed

Sources/pulls/Client.swift

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1478,8 +1478,8 @@ public struct Client: APIProtocol {
14781478
///
14791479
/// Lists the files in a specified pull request.
14801480
///
1481-
/// **Note:** Responses include a maximum of 3000 files. The paginated response
1482-
/// returns 30 files per page by default.
1481+
/// > [!NOTE]
1482+
/// > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
14831483
///
14841484
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
14851485
///
@@ -2246,7 +2246,8 @@ public struct Client: APIProtocol {
22462246
///
22472247
/// Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."
22482248
///
2249-
/// **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
2249+
/// > [!NOTE]
2250+
/// > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
22502251
///
22512252
/// The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
22522253
///
@@ -2815,9 +2816,8 @@ public struct Client: APIProtocol {
28152816
///
28162817
/// Dismisses a specified review on a pull request.
28172818
///
2818-
/// **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection),
2819-
/// you must be a repository administrator or be included in the list of people or teams
2820-
/// who can dismiss pull request reviews.
2819+
/// > [!NOTE]
2820+
/// > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
28212821
///
28222822
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
28232823
///

Sources/pulls/Types.swift

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -217,8 +217,8 @@ public protocol APIProtocol: Sendable {
217217
///
218218
/// Lists the files in a specified pull request.
219219
///
220-
/// **Note:** Responses include a maximum of 3000 files. The paginated response
221-
/// returns 30 files per page by default.
220+
/// > [!NOTE]
221+
/// > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
222222
///
223223
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
224224
///
@@ -289,7 +289,8 @@ public protocol APIProtocol: Sendable {
289289
///
290290
/// Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."
291291
///
292-
/// **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
292+
/// > [!NOTE]
293+
/// > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
293294
///
294295
/// The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
295296
///
@@ -363,9 +364,8 @@ public protocol APIProtocol: Sendable {
363364
///
364365
/// Dismisses a specified review on a pull request.
365366
///
366-
/// **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection),
367-
/// you must be a repository administrator or be included in the list of people or teams
368-
/// who can dismiss pull request reviews.
367+
/// > [!NOTE]
368+
/// > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
369369
///
370370
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
371371
///
@@ -722,8 +722,8 @@ extension APIProtocol {
722722
///
723723
/// Lists the files in a specified pull request.
724724
///
725-
/// **Note:** Responses include a maximum of 3000 files. The paginated response
726-
/// returns 30 files per page by default.
725+
/// > [!NOTE]
726+
/// > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
727727
///
728728
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
729729
///
@@ -854,7 +854,8 @@ extension APIProtocol {
854854
///
855855
/// Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."
856856
///
857-
/// **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
857+
/// > [!NOTE]
858+
/// > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
858859
///
859860
/// The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
860861
///
@@ -974,9 +975,8 @@ extension APIProtocol {
974975
///
975976
/// Dismisses a specified review on a pull request.
976977
///
977-
/// **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection),
978-
/// you must be a repository administrator or be included in the list of people or teams
979-
/// who can dismiss pull request reviews.
978+
/// > [!NOTE]
979+
/// > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
980980
///
981981
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
982982
///
@@ -9938,8 +9938,8 @@ public enum Operations {
99389938
///
99399939
/// Lists the files in a specified pull request.
99409940
///
9941-
/// **Note:** Responses include a maximum of 3000 files. The paginated response
9942-
/// returns 30 files per page by default.
9941+
/// > [!NOTE]
9942+
/// > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
99439943
///
99449944
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
99459945
///
@@ -11588,7 +11588,8 @@ public enum Operations {
1158811588
///
1158911589
/// Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."
1159011590
///
11591-
/// **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
11591+
/// > [!NOTE]
11592+
/// > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
1159211593
///
1159311594
/// The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
1159411595
///
@@ -12751,9 +12752,8 @@ public enum Operations {
1275112752
///
1275212753
/// Dismisses a specified review on a pull request.
1275312754
///
12754-
/// **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection),
12755-
/// you must be a repository administrator or be included in the list of people or teams
12756-
/// who can dismiss pull request reviews.
12755+
/// > [!NOTE]
12756+
/// > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
1275712757
///
1275812758
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
1275912759
///

0 commit comments

Comments
 (0)