🌐 chore: translate non-English comments to English in src/store/tool #10650
+124
−124
Conversation
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
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Reviewer's GuideThis PR translates existing non-English (Chinese) comments and JSDoc blocks to English across several tool-related store slices without modifying any runtime logic or behavior. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
TestGru AssignmentSummary
Files
Tip You can |
Contributor
There was a problem hiding this comment.
Hey there - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `src/store/tool/slices/klavisStore/action.ts:27-36` </location>
<code_context>
*/
export interface KlavisStoreAction {
/**
- * 调用 Klavis 工具
+ * Call Klavis tool
*/
callKlavisTool: (params: CallKlavisToolParams) => Promise<CallKlavisToolResult>;
/**
- * 完成 OAuth 认证后，更新服务器状态
- * @param identifier - 服务器标识符 (e.g., 'google-calendar')
+ * After completing OAuth authentication, update server status
+ * @param identifier - Server identifier (e.g., 'google-calendar')
*/
completeKlavisServerAuth: (identifier: string) => Promise<void>;
/**
- * 创建单个 Klavis MCP Server 实例
- * @returns 创建的服务器实例，如果需要 OAuth 则返回带 oauthUrl 的对象
+ * Create a single Klavis MCP Server instance
+ * @returns Created server instance, returns object with oauthUrl if OAuth is required
*/
</code_context>
<issue_to_address>
**suggestion:** JSDoc return description doesn’t mention the `undefined` case.
Since `createKlavisServer` returns `Promise<KlavisServer | undefined>`, the docs should also call out the `undefined` case so callers don’t assume a server (or oauthUrl object) is always returned. Please update the `@returns` description to include when `undefined` is returned.
Suggested implementation:
```typescript
/**
* Create a single Klavis MCP Server instance
* @returns Created server instance, object with oauthUrl if OAuth is required, or undefined if the server cannot be created
*/
```
If there are multiple overloads or similar JSDoc blocks describing `createKlavisServer` elsewhere in the codebase (e.g., in a type declaration file or interface definition), the same `@returns` clarification should be applied there to keep the documentation consistent with the `Promise<KlavisServer | undefined>` return type.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
27
to
36
| /** | ||
| * 调用 Klavis 工具 | ||
| * Call Klavis tool | ||
| */ | ||
| callKlavisTool: (params: CallKlavisToolParams) => Promise<CallKlavisToolResult>; | ||
|
|
||
| /** | ||
| * 完成 OAuth 认证后，更新服务器状态 | ||
| * @param identifier - 服务器标识符 (e.g., 'google-calendar') | ||
| * After completing OAuth authentication, update server status | ||
| * @param identifier - Server identifier (e.g., 'google-calendar') | ||
| */ | ||
| completeKlavisServerAuth: (identifier: string) => Promise<void>; |
Contributor
There was a problem hiding this comment.
suggestion: JSDoc return description doesn’t mention the undefined case.
Since createKlavisServer returns Promise<KlavisServer | undefined>, the docs should also call out the undefined case so callers don’t assume a server (or oauthUrl object) is always returned. Please update the @returns description to include when undefined is returned.
Suggested implementation:
/**
* Create a single Klavis MCP Server instance
* @returns Created server instance, object with oauthUrl if OAuth is required, or undefined if the server cannot be created
*/If there are multiple overloads or similar JSDoc blocks describing createKlavisServer elsewhere in the codebase (e.g., in a type declaration file or interface definition), the same @returns clarification should be applied there to keep the documentation consistent with the Promise<KlavisServer | undefined> return type.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #10650 +/- ##
========================================
Coverage 80.60% 80.60%
========================================
Files 977 977
Lines 66579 66579
Branches 10266 10606 +340
========================================
Hits 53668 53668
Misses 12911 12911
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
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.
Summary
src/store/toolChanges
Module Processed
src/store/toolFiles modified:
src/store/tool/slices/klavisStore/action.tssrc/store/tool/slices/klavisStore/selectors.tssrc/store/tool/slices/mcpStore/action.tssrc/store/tool/slices/mcpStore/initialState.tssrc/store/user/slices/auth/selectors.ts🤖 Generated with Claude Code
Summary by Sourcery
Translate non-English comments to English across tool and auth store modules without changing runtime behavior.
Enhancements:
Documentation: