refactor: condense lockdown comments in GetPullRequestCommits - #3115
Merged
Conversation
Trim the GetPullRequestCommits doc comment to a single terse sentence and remove a test comment that only restated the test name. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Condenses redundant comments without changing behavior.
Changes:
- Simplifies
GetPullRequestCommitsdocumentation. - Removes a test comment duplicating the test name.
Show a summary per file
| File | Description |
|---|---|
pkg/github/pullrequests.go |
Condenses the lockdown-mode invariant documentation. |
pkg/github/pullrequests_test.go |
Removes a redundant test-case comment. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Balanced
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
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.
Focused comment cleanup, no behavior changes.
pkg/github/pullrequests.go: condensed theGetPullRequestCommitsdoc comment to two concise sentences, keeping only the non-obvious invariant (a single PR-author check suffices since all commits share the same untrusted head branch).pkg/github/pullrequests_test.go: removed a comment on a test case that only restated the test name.script/lintandscript/testpass.