From cba28d3229ffedc104e26aa4d88d96e0abc4778a Mon Sep 17 00:00:00 2001 From: st1020 Date: Mon, 6 Nov 2023 13:12:14 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=20API=20=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/adapter/apscheduler/event.md | 2 +- .../adapter/mirai/event/{mate.md => meta.md} | 18 +++++++++--------- docs/api/plugin.md | 2 +- docs/api/utils.md | 4 ++-- 4 files changed, 13 insertions(+), 13 deletions(-) rename docs/api/adapter/mirai/event/{mate.md => meta.md} (92%) diff --git a/docs/api/adapter/apscheduler/event.md b/docs/api/adapter/apscheduler/event.md index 6398338..837a4a1 100644 --- a/docs/api/adapter/apscheduler/event.md +++ b/docs/api/adapter/apscheduler/event.md @@ -10,7 +10,7 @@ APSchedulerEvent 事件基类。 - **Attributes** - - **type** (_str_) + - **type** (_Optional\[str\]_) - **plugin\_class** (_Type\[alicebot.plugin.Plugin\]_) diff --git a/docs/api/adapter/mirai/event/mate.md b/docs/api/adapter/mirai/event/meta.md similarity index 92% rename from docs/api/adapter/mirai/event/mate.md rename to docs/api/adapter/mirai/event/meta.md index 1166a76..16d5604 100644 --- a/docs/api/adapter/mirai/event/mate.md +++ b/docs/api/adapter/mirai/event/meta.md @@ -1,8 +1,8 @@ -# alicebot.adapter.mirai.event.mate +# alicebot.adapter.mirai.event.meta 默认不会被传播的特殊事件。 -## _class_ `MateEvent` {#MateEvent} +## _class_ `MetaEvent` {#MetaEvent} Bases: `alicebot.adapter.mirai.event.base.MiraiEvent` @@ -28,7 +28,7 @@ allow `self` as a field name. ## _class_ `BotEvent` {#BotEvent} -Bases: `alicebot.adapter.mirai.event.mate.MateEvent` +Bases: `alicebot.adapter.mirai.event.meta.MetaEvent` Bot 自身事件 @@ -56,7 +56,7 @@ allow `self` as a field name. ## _class_ `BotOnlineEvent` {#BotOnlineEvent} -Bases: `alicebot.adapter.mirai.event.mate.BotEvent` +Bases: `alicebot.adapter.mirai.event.meta.BotEvent` Bot 登录成功 @@ -84,7 +84,7 @@ allow `self` as a field name. ## _class_ `BotOfflineEventActive` {#BotOfflineEventActive} -Bases: `alicebot.adapter.mirai.event.mate.BotEvent` +Bases: `alicebot.adapter.mirai.event.meta.BotEvent` Bot 主动离线 @@ -112,7 +112,7 @@ allow `self` as a field name. ## _class_ `BotOfflineEventForce` {#BotOfflineEventForce} -Bases: `alicebot.adapter.mirai.event.mate.BotEvent` +Bases: `alicebot.adapter.mirai.event.meta.BotEvent` Bot 被挤下线 @@ -140,7 +140,7 @@ allow `self` as a field name. ## _class_ `BotOfflineEventDropped` {#BotOfflineEventDropped} -Bases: `alicebot.adapter.mirai.event.mate.BotEvent` +Bases: `alicebot.adapter.mirai.event.meta.BotEvent` Bot 被服务器断开或因网络问题而掉线 @@ -168,7 +168,7 @@ allow `self` as a field name. ## _class_ `BotReloginEvent` {#BotReloginEvent} -Bases: `alicebot.adapter.mirai.event.mate.BotEvent` +Bases: `alicebot.adapter.mirai.event.meta.BotEvent` Bot 主动重新登录 @@ -196,7 +196,7 @@ allow `self` as a field name. ## _class_ `CommandExecutedEvent` {#CommandExecutedEvent} -Bases: `alicebot.adapter.mirai.event.mate.MateEvent` +Bases: `alicebot.adapter.mirai.event.meta.MetaEvent` 命令被执行 diff --git a/docs/api/plugin.md b/docs/api/plugin.md index 2d068ee..afc7c13 100644 --- a/docs/api/plugin.md +++ b/docs/api/plugin.md @@ -24,7 +24,7 @@ Bases: `abc.ABC`, `typing.Generic` - **Config** (_Type\[~ConfigT\]_) - - **event** (_~EventT_) - 当前正在被此插件处理的事件。 + - **event** - 当前正在被此插件处理的事件。 - **\_\_plugin\_load\_type\_\_** - 插件加载类型,由 AliceBot 自动设置,反映了此插件是如何被加载的。 diff --git a/docs/api/utils.md b/docs/api/utils.md index 7f91f12..782572b 100644 --- a/docs/api/utils.md +++ b/docs/api/utils.md @@ -172,9 +172,9 @@ version of the object or raise a ``TypeError``. - **Arguments** - - **path1** (_Union\[str, bytes, os.PathLike\[str\], os.PathLike\[bytes\]\]_) - 路径1。 + - **path1** (_Union\[str, bytes, PathLike\[str\], PathLike\[bytes\]\]_) - 路径1。 - - **path2** (_Union\[str, bytes, os.PathLike\[str\], os.PathLike\[bytes\]\]_) - 路径2。 + - **path2** (_Union\[str, bytes, PathLike\[str\], PathLike\[bytes\]\]_) - 路径2。 - **Returns**