Skip to content

Commit 77c50b2

Browse files
authored
Merge pull request #1189 from t0m4uk1991/update_ghpullrequestfiledetail_docs
Update javadocs for GHPullRequestFileDetail
2 parents ebdbf8f + 01e25d0 commit 77c50b2

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

src/main/java/org/kohsuke/github/GHPullRequest.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,9 +388,13 @@ public void refresh() throws IOException {
388388
}
389389

390390
/**
391-
* Retrieves all the files associated to this pull request.
391+
* Retrieves all the files associated to this pull request. The paginated response returns 30 files per page by
392+
* default.
392393
*
393394
* @return the paged iterable
395+
*
396+
* @see <a href="https://docs.github.com/en/rest/reference/pulls#list-pull-requests-files">List pull requests
397+
* files</a>
394398
*/
395399
public PagedIterable<GHPullRequestFileDetail> listFiles() {
396400
return root.createRequest()

src/main/java/org/kohsuke/github/GHPullRequestFileDetail.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
*
3131
* @author Julien Henry
3232
* @see GHPullRequest#listFiles() GHPullRequest#listFiles()
33+
* @see <a href="https://docs.github.com/en/rest/reference/pulls#list-pull-requests-files">List pull requests files</a>
3334
*/
3435
public class GHPullRequestFileDetail {
3536

@@ -46,7 +47,10 @@ public class GHPullRequestFileDetail {
4647
String previous_filename;
4748

4849
/**
49-
* Gets sha.
50+
* Gets sha of the file (not commit sha).
51+
*
52+
* @see <a href="https://docs.github.com/en/rest/reference/pulls#list-pull-requests-files">List pull requests
53+
* files</a>
5054
*
5155
* @return the sha
5256
*/
@@ -64,7 +68,7 @@ public String getFilename() {
6468
}
6569

6670
/**
67-
* Gets status.
71+
* Gets status (added/modified/deleted)
6872
*
6973
* @return the status
7074
*/

0 commit comments

Comments
 (0)