Skip to content

docs: Clarify ListPullRequestsWithCommit usage - #3465

Merged
gmlewis merged 1 commit into
google:masterfrom
evanelias:doc-fix-ListPullRequestsWithCommit
Feb 6, 2025
Merged

docs: Clarify ListPullRequestsWithCommit usage#3465
gmlewis merged 1 commit into
google:masterfrom
evanelias:doc-fix-ListPullRequestsWithCommit

Conversation

@evanelias

Copy link
Copy Markdown
Contributor

The docs for ListPullRequestsWithCommit mention use of PullRequestListOptions, but this method no longer accepts PullRequestListOptions per #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.

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.

@gmlewisgmlewis left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @evanelias!
LGTM.
Merging.

@gmlewisgmlewis changed the title docs: clarify ListPullRequestsWithCommit usagedocs: Clarify ListPullRequestsWithCommit usageFeb 5, 2025
@codecov

codecovBot commented Feb 5, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.03%. Comparing base (a4333f3) to head (bd4212e).
Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

@gmlewis
gmlewis merged commit 24b0795 into google:masterFeb 6, 2025
jlaportebot added a commit to jlaportebot/go-github that referenced this pull request Jun 28, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@evanelias@gmlewis