docs: Add clarifications for mergeable field in pull requests #3396
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gmlewis
changed the title
gmlewis
requested changes
Dec 21, 2024
| RequestedReviewers []*User `json:"requested_reviewers,omitempty"` | ||
| AutoMerge *PullRequestAutoMerge `json:"auto_merge,omitempty"` | ||
|
|
||
| // Merged is not populated by List operation. |
There was a problem hiding this comment.
It is unnecessary and overly verbose to individually list each field's name separately.
Instead, please simply make this a block with a single comment at the top, like this:
Suggested change
| // Merged is not populated by List operation. | |
| // These fields are not populated by the List operation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Comparing the OpenAPI spec for pull requests shows that these fields are not populated when listing (right), but they are through GET or webhook:
In their OpenAPI Spec they have
pull-requestandpull-request-simpledefinitions.I think that would make sense to also have these structs instead of relying on comments for contextual field population.