Merged
Conversation
Contributor
|
🧙 Sourcery 正在审查您的拉取请求！ 提示和命令与 Sourcery 互动
自定义您的体验访问您的 仪表板 以：
获取帮助Original review guide in English🧙 Sourcery is reviewing your pull request! Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
你好 - 我已经审阅了你的更改，它们看起来很棒！
AI 代理提示
请处理此代码审查中的评论：
## Individual Comments
### Comment 1
<location> `packages/core/src/adapter/render/admin/types.ts:73-78` </location>
<code_context>
* 图像的编码方式。
*
- * @deprecated 这是无效选项，强制性返回string<base64>
+ * @deprecated 这是无效选项，强制性返回base64编码的字符串
*/
encoding?: 'base64' | 'binary'
</code_context>
<issue_to_address>
**建议：** 澄清编码选项的弃用消息。
在弃用消息中明确指出用户应该使用什么替代方案，或者明确说明该选项已被忽略，以防止混淆。
```suggestion
/**
* 图像的编码方式。
*
* @deprecated 此选项已被弃用且会被忽略，始终返回 base64 编码的字符串。请勿使用该选项，直接依赖默认行为即可。
*/
encoding?: 'base64' | 'binary'
```
</issue_to_address>帮助我更有用！请点击每个评论上的 👍 或 👎，我将利用这些反馈来改进你的审查。
Original comment in English
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> `packages/core/src/adapter/render/admin/types.ts:73-78` </location>
<code_context>
* 图像的编码方式。
*
- * @deprecated 这是无效选项，强制性返回string<base64>
+ * @deprecated 这是无效选项，强制性返回base64编码的字符串
*/
encoding?: 'base64' | 'binary'
</code_context>
<issue_to_address>
**suggestion:** Clarify the deprecation message for encoding option.
Specify in the deprecation message what users should use instead, or clearly state that the option is ignored to prevent confusion.
```suggestion
/**
* 图像的编码方式。
*
* @deprecated 此选项已被弃用且会被忽略，始终返回 base64 编码的字符串。请勿使用该选项，直接依赖默认行为即可。
*/
encoding?: 'base64' | 'binary'
```
</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
73
to
78
| /** | ||
| * 图像的编码方式。 | ||
| * | ||
| * @deprecated 这是无效选项，强制性返回string<base64> | ||
| * @deprecated 这是无效选项，强制性返回base64编码的字符串 | ||
| */ | ||
| encoding?: 'base64' | 'binary' |
Contributor
There was a problem hiding this comment.
建议： 澄清编码选项的弃用消息。
在弃用消息中明确指出用户应该使用什么替代方案，或者明确说明该选项已被忽略，以防止混淆。
Suggested change
| /** | |
| * 图像的编码方式。 | |
| * | |
| * @deprecated 这是无效选项，强制性返回string<base64> | |
| * @deprecated 这是无效选项，强制性返回base64编码的字符串 | |
| */ | |
| encoding?: 'base64' | 'binary' | |
| /** | |
| * 图像的编码方式。 | |
| * | |
| * @deprecated 此选项已被弃用且会被忽略，始终返回 base64 编码的字符串。请勿使用该选项，直接依赖默认行为即可。 | |
| */ | |
| encoding?: 'base64' | 'binary' |
Original comment in English
suggestion: Clarify the deprecation message for encoding option.
Specify in the deprecation message what users should use instead, or clearly state that the option is ignored to prevent confusion.
Suggested change
| /** | |
| * 图像的编码方式。 | |
| * | |
| * @deprecated 这是无效选项，强制性返回string<base64> | |
| * @deprecated 这是无效选项，强制性返回base64编码的字符串 | |
| */ | |
| encoding?: 'base64' | 'binary' | |
| /** | |
| * 图像的编码方式。 | |
| * | |
| * @deprecated 此选项已被弃用且会被忽略，始终返回 base64 编码的字符串。请勿使用该选项，直接依赖默认行为即可。 | |
| */ | |
| encoding?: 'base64' | 'binary' |
Merged
Contributor
|
你可以通过以下命令安装该版本： |
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
1 participant
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.
Sourcery 总结
配置并启用使用 TypeDoc 为核心包自动生成 API 文档的功能。
新功能：
改进：
encoding选项的弃用消息Original summary in English
Summary by Sourcery
Configure and enable automatic API documentation generation for the core package using TypeDoc.
New Features:
Enhancements: