增加对下载器版本要求的提示，优化表达、格式，同步修改英文文档 #33
Open
Conversation
This file contains 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
变更概述概览本次拉取请求主要更新了 BitComet 和 qBittorrent 的文档，增加了版本兼容性警告和使用建议。对于 BitComet，要求使用 变更
可能相关的 PR
建议的审阅者
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
docs/downloader/qBittorrent.md (3)
13-17: 版本要求警告的表述建议优化建议调整表述以更清晰地传达信息：
-PeerBanHelper 仅兼容 qBittorrent `v4.5.0` 或更高版本，不兼容 XDown。即使你在不合要求的下载器上成功运行 PeerBanHelper，我们也不会提供任何支持。 +PeerBanHelper 仅兼容 qBittorrent `v4.5.0` 及更高版本，且与 XDown 不兼容。如果您在不符合要求的下载器上运行 PeerBanHelper，即使能够成功运行，我们也不会提供任何技术支持。
36-41: 安全提示建议补充具体建议建议为每个安全提示添加具体的操作建议：
**安全提示** -请设置强密码以保护您的 qBittorrent -如果只在本地使用，建议将访问限制为 127.0.0.1 -确保防火墙配置正确，只开放必要端口 +- 请设置强密码以保护您的 qBittorrent（建议使用至少12位包含大小写字母、数字和特殊字符的密码） +- 如果只在本地使用，强烈建议在 IP 地址栏中填写 127.0.0.1 以限制访问 +- 确保防火墙配置正确，仅开放 WebUI 所需的端口，并建议设置访问白名单
55-57: 自动配置说明建议优化格式建议调整格式以提高可读性：
-在 PeerBanHelper `v7.2.0` 及以上版本，下载器连接到 PeerBanHelper 时，PeerBanHelper 会自动关闭"允许来自同一 IP 地址的多个连接"选项，如果你使用的版本正确，则无需手动配置此选项。 +从 PeerBanHelper `v7.2.0` 版本开始，当下载器连接到 PeerBanHelper 时，系统会自动关闭"允许来自同一 IP 地址的多个连接"选项。 + +> 如果您使用的是 `v7.2.0` 或更高版本，则无需手动配置此选项。docs/downloader/BitComet.md (1)
13-17: 版本要求警告的表述建议统一为保持与 qBittorrent 文档的一致性，建议调整表述：
-PeerBanHelper 仅兼容 BitComet `v2.10 Beta6 [20240928]` 或更高版本。即使你在不合要求的下载器上成功运行 PeerBanHelper，我们也不会提供任何支持。 +PeerBanHelper 仅兼容 BitComet `v2.10 Beta6 [20240928]` 及更高版本。如果您在不符合要求的下载器上运行 PeerBanHelper，即使能够成功运行，我们也不会提供任何技术支持。i18n/en/docusaurus-plugin-content-docs/current/downloader/qBittorrent.md (2)
13-17: 建议优化英文版本要求的表述建议调整英文表述以提高准确性：
-The PeerBanHelper is only compatible with qBittorrent versions `v4.5.0` and higher, and it is not compatible with XDown. Even if you manage to run PeerBanHelper successfully on an incompatible downloader, we will not provide any support for such configurations. +PeerBanHelper is only compatible with qBittorrent version `v4.5.0` or higher and is incompatible with XDown. Even if you manage to run PeerBanHelper successfully on an incompatible downloader, we will not provide any technical support.🧰 Tools
🪛 LanguageTool
[style] ~15-~15: Consider using “incompatible” to avoid wordiness.
Context: ...versionsv4.5.0and higher, and it is not compatible with XDown. Even if you manage to run P...(NOT_ABLE_PREMIUM)
54-58: 建议优化英文自动配置说明的格式建议调整格式以提高可读性：
-From version `v7.2.0` and above, when a downloader connects to PBH, the option "Allow multiple connections from -the same IP address" will automatically be disabled by qBittorrent. Therefore, if you are using the correct -version, there is no need for manual configuration of this setting. +Starting from version `v7.2.0`, when a downloader connects to PeerBanHelper, the option "Allow multiple connections from the same IP address" will be automatically disabled. + +> If you are using version `v7.2.0` or higher, there is no need to configure this setting manually.i18n/en/docusaurus-plugin-content-docs/current/downloader/BitComet.md (1)
13-17: 建议统一英文版本要求的表述风格为保持与 qBittorrent 文档的一致性，建议调整表述：
-The PeerBanHelper is only compatible with BitComet versions `v2.10 Beta6 [20240928]` and higher. Even if you manage to run PeerBanHelper successfully on an incompatible downloader, we will not provide any support for such configurations. +PeerBanHelper is only compatible with BitComet version `v2.10 Beta6 [20240928]` or higher. Even if you manage to run PeerBanHelper successfully on an incompatible downloader, we will not provide any technical support.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/downloader/BitComet.md(1 hunks)docs/downloader/qBittorrent.md(3 hunks)i18n/en/docusaurus-plugin-content-docs/current/downloader/BitComet.md(1 hunks)i18n/en/docusaurus-plugin-content-docs/current/downloader/qBittorrent.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
i18n/en/docusaurus-plugin-content-docs/current/downloader/qBittorrent.md
[style] ~15-~15: Consider using “incompatible” to avoid wordiness.
Context: ...versions v4.5.0 and higher, and it is not compatible with XDown. Even if you manage to run P...
(NOT_ABLE_PREMIUM)
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 by CodeRabbit
v2.10 Beta6 [20240928]及以上版本v4.5.0及以上版本