From f53e374521e4287cd548c694d369f2f06da846e8 Mon Sep 17 00:00:00 2001 From: yanyongyu Date: Tue, 25 Jan 2022 16:03:49 +0800 Subject: [PATCH] :pencil2: fix doc api link error --- website/docs/tutorial/configuration.md | 4 ++-- website/docs/tutorial/plugin/create-handler.md | 9 +++++++-- website/docs/tutorial/plugin/matcher-operation.md | 2 +- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/website/docs/tutorial/configuration.md b/website/docs/tutorial/configuration.md index 1e558fcc..e000c610 100644 --- a/website/docs/tutorial/configuration.md +++ b/website/docs/tutorial/configuration.md @@ -197,7 +197,7 @@ API_TIMEOUT=30.0 - **类型**: `Set[str]` - **默认值**: `set()` -机器人超级用户，可以使用权限 {ref}`nonebot.permission.SUPERUSER`。 +机器人超级用户，可以使用权限 [`SUPERUSER`](../api/permission.md#SUPERUSER)。 ```env SUPERUSERS=["1234567890"] @@ -221,7 +221,7 @@ NICKNAME=["bot"] - Command Start: `{"/"}` - Command Separator: `{"."}` -命令消息的起始符和分隔符。用于 {ref}`nonebot.rule.command` 规则。 +命令消息的起始符和分隔符。用于 [`command`](../api/rule.md#command) 规则。 ```env COMMAND_START={"/", "!"} diff --git a/website/docs/tutorial/plugin/create-handler.md b/website/docs/tutorial/plugin/create-handler.md index 15ecfdf6..63cb024e 100644 --- a/website/docs/tutorial/plugin/create-handler.md +++ b/website/docs/tutorial/plugin/create-handler.md @@ -259,17 +259,22 @@ async def _(foo: Message = CommandArg()): ... 获取 shell 命令解析后的参数。 :::tip 提示 -如果参数解析失败，则为 {ref}`nonebot.exception.ParserExit` 异常，并携带错误码与错误信息。 +如果参数解析失败，则为 [`ParserExit`](../../api/exception.md#ParserExit) 异常，并携带错误码与错误信息。 由于 `ArgumentParser` 在解析到 `--help` 参数时也会抛出异常，这种情况下错误码为 `0` 且错误信息即为帮助信息。 ::: -```python {7} +```python {8,12} from nonebot import on_shell_command from nonebot.params import ShellCommandArgs matcher = on_shell_command("cmd", parser) +# 解析失败 +@matcher.handle() +async def _(foo: ParserExit = ShellCommandArgs()): ... + +# 解析成功 @matcher.handle() async def _(foo: Dict[str, Any] = ShellCommandArgs()): ... ``` diff --git a/website/docs/tutorial/plugin/matcher-operation.md b/website/docs/tutorial/plugin/matcher-operation.md index 3803d26b..bc4208d1 100644 --- a/website/docs/tutorial/plugin/matcher-operation.md +++ b/website/docs/tutorial/plugin/matcher-operation.md @@ -16,7 +16,7 @@ options: 向用户回复一条消息。回复的方式或途径由协议适配器自行实现。 -可以是 `str`, {ref}`nonebot.adapters._message.Message`, {ref}`nonebot.adapters._message.MessageSegment` 或 {ref}`nonebot.adapters._template.MessageTemplate`。 +可以是 `str`, [`Message`](../../api/adapters/_message.md#Message), [`MessageSegment`](../../api/adapters/_message.md#MessageSegment) 或 [`MessageTemplate`](../../api/adapters/_template.md#MessageTemplate)。 这个操作等同于使用 `bot.send(event, message, **kwargs)` 但不需要自行传入 `event`。