docs: add panic contract doc comment to prepareClaudeToolsForAllowedList - #48984
Merged
Conversation
5 tasks
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add missing panic doc contract to prepareClaudeToolsForAllowedList
docs: add panic contract doc comment to prepareClaudeToolsForAllowedList
Jul 29, 2026
pelikhan
marked this pull request as ready for review
July 29, 2026 22:02
Contributor
There was a problem hiding this comment.
Pull request overview
Adds the missing panic contract documentation for prepareClaudeToolsForAllowedList, resolving #48969 without changing behavior.
Changes:
- Documents the method’s purpose and panic condition.
- Uses the repository’s established “Panics if” convention.
Show a summary per file
| File | Description |
|---|---|
pkg/workflow/claude_tools.go |
Adds the panic contract doc comment. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Medium
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.
prepareClaudeToolsForAllowedListpanics on an invariant violation but lacked a doc comment describing this contract, relying solely on theBUG:message prefix to satisfy thepanicinlibrarycodelinter. Other exempted panic sites in the repo use explicit "Panics if …" doc comments.Changes
pkg/workflow/claude_tools.go— adds a doc comment toprepareClaudeToolsForAllowedListusing the "Panics if" phrasing per repo convention:No behavior change.