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

📝 update api docs

Browse Source
This commit is contained in:
StarHeartHunt 2021-04-05 05:52:25 +00:00
parent 1c6711355e
commit 176dbd5830
2 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/api/plugin.md
View File

@ -50,7 +50,7 @@ sidebarDepth: 0
* **说明**: 插件模块对象
### `export`
### _property_ `export`
* **类型**: `Export`
@ -282,7 +282,7 @@ sidebarDepth: 0
## `on_startswith(msg, rule=None, **kwargs)`
## `on_startswith(msg, rule=None, ignorecase=False, **kwargs)`
* **说明**
@ -294,12 +294,15 @@ sidebarDepth: 0
* **参数**
* `msg: str`: 指定消息开头内容
* `msg: Union[str, Tuple[str, ...]]`: 指定消息开头内容
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `ignorecase: bool`: 是否忽略大小写
* `permission: Optional[Permission]`: 事件响应权限
@ -329,7 +332,7 @@ sidebarDepth: 0
## `on_endswith(msg, rule=None, **kwargs)`
## `on_endswith(msg, rule=None, ignorecase=False, **kwargs)`
* **说明**
@ -341,12 +344,15 @@ sidebarDepth: 0
* **参数**
* `msg: str`: 指定消息结尾内容
* `msg: Union[str, Tuple[str, ...]]`: 指定消息结尾内容
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `ignorecase: bool`: 是否忽略大小写
* `permission: Optional[Permission]`: 事件响应权限
@ -663,7 +669,7 @@ sidebarDepth: 0
* `cmd: Union[str, Tuple[str, ...]]`: 命令前缀
* `**kwargs`: 其他传递给 `on_command` 的参数，将会覆盖命令组默认值
* `**kwargs`: 其他传递给 `on_shell_command` 的参数，将会覆盖命令组默认值
@ -940,7 +946,10 @@ sidebarDepth: 0
* **参数**
* `msg: str`: 指定消息开头内容
* `msg: Union[str, Tuple[str, ...]]`: 指定消息开头内容
* `ignorecase: bool`: 是否忽略大小写
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
@ -987,7 +996,10 @@ sidebarDepth: 0
* **参数**
* `msg: str`: 指定消息结尾内容
* `msg: Union[str, Tuple[str, ...]]`: 指定消息结尾内容
* `ignorecase: bool`: 是否忽略大小写
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则

4
docs/api/rule.md
View File

@ -91,7 +91,7 @@ Rule(async_function, run_sync(sync_function))
## `startswith(msg)`
## `startswith(msg, ignorecase=False)`
* **说明**
@ -107,7 +107,7 @@ Rule(async_function, run_sync(sync_function))
## `endswith(msg)`
## `endswith(msg, ignorecase=False)`
* **说明**