ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2024-11-28 08:12:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Richard Chien 2019-01-06 21:50:45 +08:00
parent 3ab3904d60
commit dd58241bb0
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api.md
View File

@ -312,7 +312,7 @@ sidebar: auto
- `load_plugin` -> `nonebot.plugin.load_plugin` - `load_plugin` -> `nonebot.plugin.load_plugin`
- `load_plugins` -> `nonebot.plugin.load_plugins` - `load_plugins` -> `nonebot.plugin.load_plugins`
- `load_builtin_plugins` -> `nonebot.plugin.load_builtin_plugins` - `load_builtin_plugins` -> `nonebot.plugin.load_builtin_plugins`
- `get_loaded_plugins` -> `nonebot.plugin.get_loaded_plugins` - `get_loaded_plugins` <Badge text="1.1.0+"/> -> `nonebot.plugin.get_loaded_plugins`
- `message_preprocessor` -> `nonebot.message.message_preprocessor` - `message_preprocessor` -> `nonebot.message.message_preprocessor`
- `Message` -> `nonebot.message.Message` - `Message` -> `nonebot.message.Message`
- `MessageSegment` -> `nonebot.message.MessageSegment` - `MessageSegment` -> `nonebot.message.MessageSegment`
@ -1207,7 +1207,7 @@ sidebar: auto
- `name: Union[str, CommandName_T]`: 命令名，如果传入的是字符串则会自动转为元组 - `name: Union[str, CommandName_T]`: 命令名，如果传入的是字符串则会自动转为元组
- `aliases: Iterable[str]`: 命令别名 - `aliases: Iterable[str]`: 命令别名
- `permission: int`: 命令所需要的权限，不满足权限的用户将无法触发该命令 - `permission: int`: 命令所需要的权限，不满足权限的用户将无法触发该命令
- `only_to_me: bool`: 是否只响应确定是在和「我」（机器人）说话的命令 - `only_to_me: bool`: 是否只响应确定是在和「我」（机器人）说话的命令（在开头或结尾 @ 了机器人）
- `privileged: bool`: 是否特权命令，若是，则无论当前是否有命令会话正在运行，都会运行该命令，但运行不会覆盖已有会话，也不会保留新创建的会话 - `privileged: bool`: 是否特权命令，若是，则无论当前是否有命令会话正在运行，都会运行该命令，但运行不会覆盖已有会话，也不会保留新创建的会话
- `shell_like: bool`: 是否使用类 shell 语法，若是，则会自动使用 `shlex` 模块进行分割（无需手动编写参数解析器），分割后的参数列表放入 `session.args['argv']` - `shell_like: bool`: 是否使用类 shell 语法，若是，则会自动使用 `shlex` 模块进行分割（无需手动编写参数解析器），分割后的参数列表放入 `session.args['argv']`
@ -1591,9 +1591,9 @@ sidebar: auto
- `keywords: Optional[Iterable]`: 要响应的关键词，若传入 `None`，则响应所有消息 - `keywords: Optional[Iterable]`: 要响应的关键词，若传入 `None`，则响应所有消息
- `permission: int`: 自然语言处理器所需要的权限，不满足权限的用户将无法触发该处理器 - `permission: int`: 自然语言处理器所需要的权限，不满足权限的用户将无法触发该处理器
- `only_to_me: bool`: 是否只响应确定是在和「我」（机器人）说话的消息 - `only_to_me: bool`: 是否只响应确定是在和「我」（机器人）说话的消息（在开头或结尾 @ 了机器人，或在开头称呼了机器人昵称）
- `only_short_message: bool`: 是否只响应短消息 - `only_short_message: bool`: 是否只响应短消息
- `allow_empty_message: bool`: 是否响应内容为空的消息（只有@或机器人昵称） - `allow_empty_message: bool`: 是否响应内容为空的消息（只有 @ 或机器人昵称）
- **要求:** - **要求:**

3
docs/changelog.md
View File

@ -4,12 +4,13 @@ sidebar: auto
# 更新日志 # 更新日志
## next ## v1.1.0
- 插件模块现可通过 `__plugin_name__` 和 `__plugin_usage__` 来分别指定插件名称和插件使用方法（两者均不强制，若不设置则默认为 `None`） - 插件模块现可通过 `__plugin_name__` 和 `__plugin_usage__` 来分别指定插件名称和插件使用方法（两者均不强制，若不设置则默认为 `None`）
- 新增 `nonebot.plugin.get_loaded_plugins()` 函数用于获取所有已加载的插件集合 - 新增 `nonebot.plugin.get_loaded_plugins()` 函数用于获取所有已加载的插件集合
- `BaseSession.send()` 方法和 `nonebot.helpers.send()` 函数现返回 API 调用返回值（即 CQHTTP 插件的返回结果的 `data` 字段） - `BaseSession.send()` 方法和 `nonebot.helpers.send()` 函数现返回 API 调用返回值（即 CQHTTP 插件的返回结果的 `data` 字段）
- `BaseSession` 新增 `self_id` 属性，可通过 `session.self_id` 代替 `session.ctx['self_id']` 来获取当前机器人账号 - `BaseSession` 新增 `self_id` 属性，可通过 `session.self_id` 代替 `session.ctx['self_id']` 来获取当前机器人账号
- `only_to_me` 的命令现可以通过在消息结尾 @ 机器人触发，而不必在开头
## v1.0.0 ## v1.0.0