From 8d0951a81625ff01daf1400e9a6ce9bdfd0dce1e Mon Sep 17 00:00:00 2001 From: hemengyang Date: Sat, 15 Jan 2022 09:35:30 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20fix=20wrong=20syntax=20and=20lin?= =?UTF-8?q?k?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- nonebot/permission.py | 2 +- nonebot/rule.py | 8 +-- nonebot/typing.py | 88 ++++++++++++------------- website/docs/advanced/permission.md | 2 +- website/docs/advanced/publish-plugin.md | 2 +- 5 files changed, 51 insertions(+), 51 deletions(-) diff --git a/nonebot/permission.py b/nonebot/permission.py index c8b07871..f3fa8253 100644 --- a/nonebot/permission.py +++ b/nonebot/permission.py @@ -3,7 +3,7 @@ 每个 `Matcher` 拥有一个 `Permission` ，其中是 `PermissionChecker` 的集合，只要有一个 `PermissionChecker` 检查结果为 `True` 时就会继续运行。 -::: tip 提示 +:::tip 提示 `PermissionChecker` 既可以是 async function 也可以是 sync function ::: """ diff --git a/nonebot/rule.py b/nonebot/rule.py index d0d0e7b8..5a3c446c 100644 --- a/nonebot/rule.py +++ b/nonebot/rule.py @@ -3,7 +3,7 @@ 每个事件响应器 `Matcher` 拥有一个匹配规则 `Rule` ，其中是 `RuleChecker` 的集合，只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行。 -::: tip 提示 +:::tip 提示 `RuleChecker` 既可以是 async function 也可以是 sync function ::: """ @@ -298,7 +298,7 @@ def command(*cmds: Union[str, Tuple[str, ...]]) -> Rule: 命令 `("test",)` 可以匹配：`/test` 开头的消息 命令 `("test", "sub")` 可以匹配”`/test.sub` 开头的消息 - ::: tip 提示 + :::tip 提示 命令内容与后续消息间无需空格！ ::: """ @@ -403,7 +403,7 @@ def shell_command( rule = shell_command("ls", parser=parser) ``` - ::: tip 提示 + :::tip 提示 命令内容与后续消息间无需空格！ ::: """ @@ -464,7 +464,7 @@ def regex(regex: str, flags: Union[int, re.RegexFlag] = 0) -> Rule: regex: 正则表达式 flags: 正则标志 - ::: tip 提示 + :::tip 提示 正则表达式匹配使用 search 而非 match，如需从头匹配请使用 `r"^xxx"` 来确保匹配开头 ::: """ diff --git a/nonebot/typing.py b/nonebot/typing.py index 938e92ba..b93f5108 100644 --- a/nonebot/typing.py +++ b/nonebot/typing.py @@ -65,11 +65,11 @@ T_EventPreProcessor = Callable[..., Union[None, Awaitable[None]]] 依赖参数: - - DependParam: 子依赖参数 - - BotParam: Bot 对象 - - EventParam: Event 对象 - - StateParam: State 对象 - - DefaultParam: 带有默认值的参数 +- DependParam: 子依赖参数 +- BotParam: Bot 对象 +- EventParam: Event 对象 +- StateParam: State 对象 +- DefaultParam: 带有默认值的参数 """ T_EventPostProcessor = Callable[..., Union[None, Awaitable[None]]] """ @@ -77,11 +77,11 @@ T_EventPostProcessor = Callable[..., Union[None, Awaitable[None]]] 依赖参数: - - DependParam: 子依赖参数 - - BotParam: Bot 对象 - - EventParam: Event 对象 - - StateParam: State 对象 - - DefaultParam: 带有默认值的参数 +- DependParam: 子依赖参数 +- BotParam: Bot 对象 +- EventParam: Event 对象 +- StateParam: State 对象 +- DefaultParam: 带有默认值的参数 """ T_RunPreProcessor = Callable[..., Union[None, Awaitable[None]]] """ @@ -89,12 +89,12 @@ T_RunPreProcessor = Callable[..., Union[None, Awaitable[None]]] 依赖参数: - - DependParam: 子依赖参数 - - BotParam: Bot 对象 - - EventParam: Event 对象 - - StateParam: State 对象 - - MatcherParam: Matcher 对象 - - DefaultParam: 带有默认值的参数 +- DependParam: 子依赖参数 +- BotParam: Bot 对象 +- EventParam: Event 对象 +- StateParam: State 对象 +- MatcherParam: Matcher 对象 +- DefaultParam: 带有默认值的参数 """ T_RunPostProcessor = Callable[..., Union[None, Awaitable[None]]] """ @@ -102,13 +102,13 @@ T_RunPostProcessor = Callable[..., Union[None, Awaitable[None]]] 依赖参数: - - DependParam: 子依赖参数 - - BotParam: Bot 对象 - - EventParam: Event 对象 - - StateParam: State 对象 - - MatcherParam: Matcher 对象 - - ExceptionParam: 异常对象（可能为 None） - - DefaultParam: 带有默认值的参数 +- DependParam: 子依赖参数 +- BotParam: Bot 对象 +- EventParam: Event 对象 +- StateParam: State 对象 +- MatcherParam: Matcher 对象 +- ExceptionParam: 异常对象（可能为 None） +- DefaultParam: 带有默认值的参数 """ T_RuleChecker = Callable[..., Union[bool, Awaitable[bool]]] @@ -117,11 +117,11 @@ RuleChecker 即判断是否响应事件的处理函数。 依赖参数: - - DependParam: 子依赖参数 - - BotParam: Bot 对象 - - EventParam: Event 对象 - - StateParam: State 对象 - - DefaultParam: 带有默认值的参数 +- DependParam: 子依赖参数 +- BotParam: Bot 对象 +- EventParam: Event 对象 +- StateParam: State 对象 +- DefaultParam: 带有默认值的参数 """ T_PermissionChecker = Callable[..., Union[bool, Awaitable[bool]]] """ @@ -129,10 +129,10 @@ RuleChecker 即判断是否响应消息的处理函数。 依赖参数: - - DependParam: 子依赖参数 - - BotParam: Bot 对象 - - EventParam: Event 对象 - - DefaultParam: 带有默认值的参数 +- DependParam: 子依赖参数 +- BotParam: Bot 对象 +- EventParam: Event 对象 +- DefaultParam: 带有默认值的参数 """ T_Handler = Callable[..., Any] @@ -145,12 +145,12 @@ TypeUpdater 在 Matcher.pause, Matcher.reject 时被运行，用于更新响应 依赖参数: - - DependParam: 子依赖参数 - - BotParam: Bot 对象 - - EventParam: Event 对象 - - StateParam: State 对象 - - MatcherParam: Matcher 对象 - - DefaultParam: 带有默认值的参数 +- DependParam: 子依赖参数 +- BotParam: Bot 对象 +- EventParam: Event 对象 +- StateParam: State 对象 +- MatcherParam: Matcher 对象 +- DefaultParam: 带有默认值的参数 """ T_PermissionUpdater = Callable[..., Union["Permission", Awaitable["Permission"]]] """ @@ -158,12 +158,12 @@ PermissionUpdater 在 Matcher.pause, Matcher.reject 时被运行，用于更新 依赖参数: - - DependParam: 子依赖参数 - - BotParam: Bot 对象 - - EventParam: Event 对象 - - StateParam: State 对象 - - MatcherParam: Matcher 对象 - - DefaultParam: 带有默认值的参数 +- DependParam: 子依赖参数 +- BotParam: Bot 对象 +- EventParam: Event 对象 +- StateParam: State 对象 +- MatcherParam: Matcher 对象 +- DefaultParam: 带有默认值的参数 """ T_DependencyCache = Dict[Callable[..., Any], "Task[Any]"] """ diff --git a/website/docs/advanced/permission.md b/website/docs/advanced/permission.md index a8ba5738..2e825dab 100644 --- a/website/docs/advanced/permission.md +++ b/website/docs/advanced/permission.md @@ -33,7 +33,7 @@ async def _(bot: Bot, event: Event): 在这段代码中，我们事件响应器指定了 `SUPERUSER` 这样一个权限，那么机器人只会响应超级管理员的 `测试超管` 命令，并且会响应该超级管理员的连续对话。 -::: tip 提示 +:::tip 提示 在这里需要强调的是，`Permission` 与 `Rule` 的表现并不相同， `Rule` 只会在初次响应时生效，在余下的对话中并没有限制事件；但是 `Permission` 会持续生效，在连续对话中会一直对事件主体加以限制。 diff --git a/website/docs/advanced/publish-plugin.md b/website/docs/advanced/publish-plugin.md index a53b635c..1671fd3b 100644 --- a/website/docs/advanced/publish-plugin.md +++ b/website/docs/advanced/publish-plugin.md @@ -9,7 +9,7 @@ options: ## 前注 -本章节仅包含插件发布流程指导，插件开发请查阅 **[创建插件](../tutorial/plugin/config-plugin.md)** 章节与 **[Plugin API 文档](../api/plugin/plugin.md)** 。 +本章节仅包含插件发布流程指导，插件开发请查阅 **[创建插件](../tutorial/plugin/introduction.md)** 章节与 **[Plugin API 文档](../api/plugin/index.md)** 。 ## 插件发布流程