Improve PullReview docs #469

Merged
6543 merged 5 commits from :review-docs into master 2020-12-17 10:14:17 +00:00

View File

@ -33,15 +33,17 @@ const (
// PullReview represents a pull request review
type PullReview struct {
ID int64 `json:"id"`
Reviewer *User `json:"user"`
State ReviewStateType `json:"state"`
Body string `json:"body"`
CommitID string `json:"commit_id"`
Stale bool `json:"stale"`
Official bool `json:"official"`
CodeCommentsCount int `json:"comments_count"`
Submitted time.Time `json:"submitted_at"`
ID int64 `json:"id"`
Reviewer *User `json:"user"`
State ReviewStateType `json:"state"`
Body string `json:"body"`
CommitID string `json:"commit_id"`
// Stale indicates if the pull has changed since the review
6543 marked this conversation as resolved Outdated
Outdated
Review

it doesnt care of commit, it care if pull has changed since reviewed

it doesnt care of commit, it care if pull has changed since reviewed
Stale bool `json:"stale"`
// Official indicates if the review counts towards the required approval limit, if PR base is a protected branch
6543 marked this conversation as resolved Outdated
Outdated
Review

if it is made to a protected branch

if it is made to a protected branch
Official bool `json:"official"`
CodeCommentsCount int `json:"comments_count"`
Submitted time.Time `json:"submitted_at"`
HTMLURL string `json:"html_url"`
HTMLPullURL string `json:"pull_request_url"`