From b8b29a444401789c7428a501e684a840f83e4b0f Mon Sep 17 00:00:00 2001 From: yixinNB <58894205+yixinNB@users.noreply.github.com> Date: Mon, 29 Jul 2024 16:59:53 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20Docs:=20=E6=9B=B4=E6=96=B0nb-cli?= =?UTF-8?q?=E8=BF=90=E8=A1=8C=E8=84=9A=E6=9C=AC;=20=E4=BF=AE=E6=94=B9md?= =?UTF-8?q?=E6=96=87=E6=9C=AC=E6=A0=BC=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- website/docs/appendices/config.mdx | 2 +- website/docs/tutorial/application.md | 4 ++-- website/docs/tutorial/matcher.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/website/docs/appendices/config.mdx b/website/docs/appendices/config.mdx index d0822352..0f764f2e 100644 --- a/website/docs/appendices/config.mdx +++ b/website/docs/appendices/config.mdx @@ -180,7 +180,7 @@ nonebot.init(_env_file=".env.dev") 在一个涉及大量配置项的项目中，通过直接读取配置项的方式显然并不高效。同时，由于额外的全局配置项没有预先定义，开发时编辑器将无法提示字段与类型，并且运行时没有对配置项直接进行合法性检查。那么就需要一种方式来规范定义插件配置项。 -插件的配置除了用来保存 api_key 以及类似的配置项以外，也常用于保存插件的状态。例如下方代码的 `weather_plugin_enabled` 就用于保存插件是否启用。[权限控制](./permission.mdx)中我们将学习如何只允许超级用户通过消息命令设置插件的状态。 +插件的配置除了用来保存 `api_key` 以及类似的配置项以外，也常用于保存插件的状态。例如下方代码的 `weather_plugin_enabled` 就用于保存插件是否启用。[权限控制](./permission.mdx)中我们将学习如何只允许超级用户通过消息命令设置插件的状态。 在 NoneBot 中，我们使用强大高效的 `pydantic` 来定义配置模型，这个模型可以被用于配置的读取和类型检查等。例如在 `weather` 插件目录中新建 `config.py` 来定义一个模型： diff --git a/website/docs/tutorial/application.md b/website/docs/tutorial/application.md index 2faa8b1a..fca6cf21 100644 --- a/website/docs/tutorial/application.md +++ b/website/docs/tutorial/application.md @@ -104,7 +104,7 @@ if __name__ == "__main__": 在**项目文件夹**中，使用配置好环境的 Python 解释器运行入口文件（如果使用虚拟环境，请先激活虚拟环境）: ```bash -python bot.py +python bot.py --reload ``` -如果你后续使用了 `nb-cli` ，你仍可以使用 `nb run` 命令来运行机器人，`nb-cli` 会自动检测入口文件 `bot.py` 是否存在并运行。 +如果你后续使用了 `nb-cli` ，你仍可以使用 `nb run` 命令来运行机器人，`nb-cli` 会自动检测入口文件 `bot.py` 是否存在并运行。`--reload` 意味着 `nb-cli` 会自动检测代码的更改并自动重新运行代码。 diff --git a/website/docs/tutorial/matcher.md b/website/docs/tutorial/matcher.md index 6cddae3a..b5f66ad7 100644 --- a/website/docs/tutorial/matcher.md +++ b/website/docs/tutorial/matcher.md @@ -53,7 +53,7 @@ from nonebot.rule import to_me weather = on_command("天气", rule=to_me(), aliases={"weather", "查天气"}, priority=10, block=True) ``` -这样，我们就获得了一个可以响应 `天气`、`weather`、`查天气` 三个命令的响应规则，需要私聊或 `@bot` 时才会响应，优先级为 10（越小越先），阻断事件传播（block=True, 不响应优先级的值更大的matcher）的事件响应器了。这些内容的意义和使用方法将会在后续的章节中一一介绍。 +这样，我们就获得了一个可以响应 `天气`、`weather`、`查天气` 三个命令的响应规则，需要私聊或 `@bot` 时才会响应，优先级为 10（越小越先），阻断事件传播（`block=True` 表示不响应优先级的值更大的响应器）的事件响应器了。这些内容的意义和使用方法将会在后续的章节中一一介绍。 :::tip 提示 -需要注意的是，不同的辅助函数有不同的可选参数，在使用之前可以参考[事件响应器进阶](../advanced/matcher.md)中的[基本辅助函数](../advanced/matcher.md#基本辅助函数)，rule请参考[内置响应规则](../advanced/matcher.md#内置响应规则)。 +需要注意的是，不同的辅助函数有不同的可选参数，在使用之前可以参考[事件响应器进阶](../advanced/matcher.md)中的[基本辅助函数](../advanced/matcher.md#基本辅助函数)，rule 请参考[内置响应规则](../advanced/matcher.md#内置响应规则)。 :::