Skip to content

Update javadocs for GHPullRequestFileDetail #1189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 28, 2021
Merged

Update javadocs for GHPullRequestFileDetail #1189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/main/java/org/kohsuke/github/GHPullRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,9 +388,13 @@ public void refresh() throws IOException {
}

/**
* Retrieves all the files associated to this pull request.
* Retrieves all the files associated to this pull request. The paginated response returns 30 files per page by
* default.
*
* @return the paged iterable
*
* @see <a href="https://docs.github.com/en/rest/reference/pulls#list-pull-requests-files">List pull requests
* files</a>
*/
public PagedIterable<GHPullRequestFileDetail> listFiles() {
return root.createRequest()
Expand Down
8 changes: 6 additions & 2 deletions src/main/java/org/kohsuke/github/GHPullRequestFileDetail.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
*
* @author Julien Henry
* @see GHPullRequest#listFiles() GHPullRequest#listFiles()
* @see <a href="https://docs.github.com/en/rest/reference/pulls#list-pull-requests-files">List pull requests files</a>
*/
public class GHPullRequestFileDetail {

Expand All @@ -46,7 +47,10 @@ public class GHPullRequestFileDetail {
String previous_filename;

/**
* Gets sha.
* Gets sha of the file (not commit sha).
*
* @see <a href="https://docs.github.com/en/rest/reference/pulls#list-pull-requests-files">List pull requests
* files</a>
*
* @return the sha
*/
Expand All @@ -64,7 +68,7 @@ public String getFilename() {
}

/**
* Gets status.
* Gets status (added/modified/deleted)
*
* @return the status
*/
Expand Down