docs: Clarify ListPullRequestsWithCommit usage#3465
Merged
gmlewis merged 1 commit intogoogle:masterfrom Feb 6, 2025
Merged
Conversation
The docs for ListPullRequestsWithCommit mention use of PullRequestListOptions, but this method no longer accepts PullRequestListOptions per google#2815 and google#2822. This commit updates the method doc comment to remove the outdated reference to PullRequestListOptions, and adds some clarifications based on the GitHub docs for the relevant API endpoint.
gmlewis
approved these changes
Feb 5, 2025
Collaborator
gmlewis
left a comment
There was a problem hiding this comment.
Thank you, @evanelias!
LGTM.
Merging.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3465 +/- ##
=======================================
Coverage 91.03% 91.03%
=======================================
Files 179 179
Lines 15538 15538
=======================================
Hits 14145 14145
Misses 1221 1221
Partials 172 172 ☔ View full report in Codecov by Sentry. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The docs for
ListPullRequestsWithCommitmention use ofPullRequestListOptions, but this method no longer acceptsPullRequestListOptionsper #2815 and #2822.This pull request updates the method doc comment to remove the outdated reference to
PullRequestListOptions, and adds some clarifications based on the GitHub docs for the relevant API endpoint.