Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 更新 API 文档 #101

Merged
merged 1 commit into from
Nov 6, 2023
Merged

docs: 更新 API 文档 #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/adapter/apscheduler/event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ APSchedulerEvent 事件基类。

- **Attributes**

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

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

Expand Down
18 changes: 9 additions & 9 deletions docs/api/adapter/mirai/event/mate.md → docs/api/adapter/mirai/event/meta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`

Expand All @@ -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 自身事件

Expand Down Expand Up @@ -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 登录成功

Expand Down Expand Up @@ -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 主动离线

Expand Down Expand Up @@ -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 被挤下线

Expand Down Expand Up @@ -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 被服务器断开或因网络问题而掉线

Expand Down Expand Up @@ -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 主动重新登录

Expand Down Expand Up @@ -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`

命令被执行

Expand Down
2 changes: 1 addition & 1 deletion docs/api/plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Bases: `abc.ABC`, `typing.Generic`

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

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

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

Expand Down
4 changes: 2 additions & 2 deletions docs/api/utils.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down