Skip to content

Commit ac72595

Browse files
docs: 更新 API 文档 (#101)
Co-authored-by: st1020 <st1020@users.noreply.github.com>
1 parent 5c05641 commit ac72595

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

docs/api/adapter/apscheduler/event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ APSchedulerEvent 事件基类。
1010

1111
- **Attributes**
1212

13-
- **type** (_str_)
13+
- **type** (_Optional\[str\]_)
1414

1515
- **plugin\_class** (_Type\[alicebot.plugin.Plugin\]_)
1616

docs/api/adapter/mirai/event/mate.md renamed to docs/api/adapter/mirai/event/meta.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# alicebot.adapter.mirai.event.mate
1+
# alicebot.adapter.mirai.event.meta
22

33
默认不会被传播的特殊事件。
44

5-
## _class_ `MateEvent` {#MateEvent}
5+
## _class_ `MetaEvent` {#MetaEvent}
66

77
Bases: `alicebot.adapter.mirai.event.base.MiraiEvent`
88

@@ -28,7 +28,7 @@ allow `self` as a field name.
2828

2929
## _class_ `BotEvent` {#BotEvent}
3030

31-
Bases: `alicebot.adapter.mirai.event.mate.MateEvent`
31+
Bases: `alicebot.adapter.mirai.event.meta.MetaEvent`
3232

3333
Bot 自身事件
3434

@@ -56,7 +56,7 @@ allow `self` as a field name.
5656

5757
## _class_ `BotOnlineEvent` {#BotOnlineEvent}
5858

59-
Bases: `alicebot.adapter.mirai.event.mate.BotEvent`
59+
Bases: `alicebot.adapter.mirai.event.meta.BotEvent`
6060

6161
Bot 登录成功
6262

@@ -84,7 +84,7 @@ allow `self` as a field name.
8484

8585
## _class_ `BotOfflineEventActive` {#BotOfflineEventActive}
8686

87-
Bases: `alicebot.adapter.mirai.event.mate.BotEvent`
87+
Bases: `alicebot.adapter.mirai.event.meta.BotEvent`
8888

8989
Bot 主动离线
9090

@@ -112,7 +112,7 @@ allow `self` as a field name.
112112

113113
## _class_ `BotOfflineEventForce` {#BotOfflineEventForce}
114114

115-
Bases: `alicebot.adapter.mirai.event.mate.BotEvent`
115+
Bases: `alicebot.adapter.mirai.event.meta.BotEvent`
116116

117117
Bot 被挤下线
118118

@@ -140,7 +140,7 @@ allow `self` as a field name.
140140

141141
## _class_ `BotOfflineEventDropped` {#BotOfflineEventDropped}
142142

143-
Bases: `alicebot.adapter.mirai.event.mate.BotEvent`
143+
Bases: `alicebot.adapter.mirai.event.meta.BotEvent`
144144

145145
Bot 被服务器断开或因网络问题而掉线
146146

@@ -168,7 +168,7 @@ allow `self` as a field name.
168168

169169
## _class_ `BotReloginEvent` {#BotReloginEvent}
170170

171-
Bases: `alicebot.adapter.mirai.event.mate.BotEvent`
171+
Bases: `alicebot.adapter.mirai.event.meta.BotEvent`
172172

173173
Bot 主动重新登录
174174

@@ -196,7 +196,7 @@ allow `self` as a field name.
196196

197197
## _class_ `CommandExecutedEvent` {#CommandExecutedEvent}
198198

199-
Bases: `alicebot.adapter.mirai.event.mate.MateEvent`
199+
Bases: `alicebot.adapter.mirai.event.meta.MetaEvent`
200200

201201
命令被执行
202202

docs/api/plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Bases: `abc.ABC`, `typing.Generic`
2424

2525
- **Config** (_Type\[~ConfigT\]_)
2626

27-
- **event** (_~EventT_) - 当前正在被此插件处理的事件。
27+
- **event** - 当前正在被此插件处理的事件。
2828

2929
- **\_\_plugin\_load\_type\_\_** - 插件加载类型,由 AliceBot 自动设置,反映了此插件是如何被加载的。
3030

docs/api/utils.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,9 @@ version of the object or raise a ``TypeError``.
172172

173173
- **Arguments**
174174

175-
- **path1** (_Union\[str, bytes, os.PathLike\[str\], os.PathLike\[bytes\]\]_) - 路径1。
175+
- **path1** (_Union\[str, bytes, PathLike\[str\], PathLike\[bytes\]\]_) - 路径1。
176176

177-
- **path2** (_Union\[str, bytes, os.PathLike\[str\], os.PathLike\[bytes\]\]_) - 路径2。
177+
- **path2** (_Union\[str, bytes, PathLike\[str\], PathLike\[bytes\]\]_) - 路径2。
178178

179179
- **Returns**
180180

0 commit comments

Comments
 (0)