docs: name the three surfaces a PR's feedback can sit on - #337
Conversation
Reading the comments on a pull request is three API calls, and the reference documented each endpoint separately without stating that all three have to be read. A maintainer can put a whole review, `suggestion` blocks included, into the review body instead of onto a diff line. Both other queries then return an empty list, so "there are no comments" is reported while a full review waits. Observed on TYPO3-Documentation/TYPO3CMS-Reference-CoreApi#6992: issue comments 0, review comments 0, one COMMENTED review carrying two suggestions. The new subsection also states the two consequences for the reply: a suggestion in a review body has no apply button, and the body is not a thread, so the answer is a PR comment citing the commit SHA. Assisted-by: claude-code:claude-opus-5 Agent-Session: https://claude.ai/code/session_01NnQTMiCugD4XCP1kptR2BE Agent-Host: 0493f0 Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
|
Warning Review limit reachedNext included review available in 57 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughAdds a subsection to the PR review workflow documentation. It explains that issue comments, reviews, and review comments require separate API queries. It also documents that suggestions in review bodies do not provide an “Apply suggestion” button and that review bodies are not threads, so responses should cite the resolving commit in a PR comment. Priority: ⬇️ Low Change: Other 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
github-actions
Bot
added
documentation
The paragraph asserted that a suggestion block in a review body carries no apply button without naming a source. GitHub documents the control as part of a line comment on the Files-changed tab, so the sentence now quotes that instruction and links the page instead of stating the consequence bare. Assisted-by: claude-code:claude-opus-5 Agent-Session: https://claude.ai/code/session_01NnQTMiCugD4XCP1kptR2BE Agent-Host: 0493f0 Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
|
|
Self-review: e00a415 The bot review this pull request demands is unsatisfiable (Copilot quota wall or repeated bot failures on this head). The diff on this head was reviewed by the PR author; this comment is the on-the-record attestation the merge gate reads back. It stops matching on the next push. |
Merging this adds a subsection to
references/pull-request-workflow.mdnaming the three API surfaces a pull request's feedback can sit on, so a reader stops concluding "no comments" from one empty query. It sits in "Reviewing a PR: Read the Standing Review State First", above the subagent-anchor subsection.The reference already documents
issues/$PR/comments,pulls/$PR/reviewsandpulls/$PR/commentsin separate places, each for its own purpose. It never says that reading a pull request's feedback means querying all three. A maintainer can write a whole review — prose plussuggestionblocks — into the review body rather than onto a diff line, and then the two obvious queries both return an empty list.Observed on TYPO3-Documentation/TYPO3CMS-Reference-CoreApi#6992 on 2026-09-18: issue comments 0, review comments 0, one
COMMENTEDreview carrying two suggestion blocks.The subsection also states the two consequences for the reply. The committable-suggestion control belongs to a line comment on the Files-changed tab, quoted from GitHub's own "Commenting on a pull request" page, so a
suggestionblock typed into a review body is ordinary fenced code and "I committed your suggestion" mis-states what happened. The body is not a thread either, so the answer is a pull request comment citing the commit SHA.Two commits: the subsection, then a follow-up that replaced the unsourced "no apply button" assertion with GitHub's documented placement rule and a link to it.
Tests: pre-commit ran markdownlint-cli2 and the repo's other hooks on both commits; all passed.
Assisted by claude-code:claude-opus-5 — Session