📝 Docs: 修复 Alconna 中 CommandResult 描述错误 (#2282)

This commit is contained in:
Komorebi 2023-08-18 11:46:39 +08:00 committed by GitHub
parent bca9e4fd08
commit 31b6df5b39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -96,7 +96,7 @@ async def login_got(password: str = AlconnaArg("password")):
可以看到,本插件提供了几类额外的模型:
- `CommandResult`: 解析结果,包括了源命令 `command: Alconna` ,解析结果 `result: Arparma`,以及可能的输出信息 `output: str | None` 字段
- `CommandResult`: 解析结果,包括了源命令 `source: Alconna` ,解析结果 `result: Arparma`,以及可能的输出信息 `output: str | None` 字段
- `Match`: 匹配项,表示参数是否存在于 `all_matched_args` 内,可用 `Match.available` 判断是否匹配,`Match.result` 获取匹配的值
- `Query`: 查询项,表示参数是否可由 `Arparma.query` 查询并获得结果,可用 `Query.available` 判断是否查询成功,`Query.result` 获取查询结果