ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-09-06 20:16:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

令参数列表符合 autodoc 格式

Browse Source
This commit is contained in:
hemengyang
2022-01-12 18:25:25 +08:00
parent 4ba1a09fb7
commit a5f32febbd
19 changed files with 361 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
nonebot/__init__.py
View File

@ -57,11 +57,11 @@ def get_driver() -> Driver:
:返回:
* `Driver`: 全局 Driver 对象
Driver: 全局 Driver 对象
:异常:
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
ValueError: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
:用法:
@ -81,11 +81,11 @@ def get_app() -> Any:
:返回:
* `Any`: Server App 对象
Any: Server App 对象
:异常:
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
ValueError: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
:用法:
@ -107,11 +107,11 @@ def get_asgi() -> Any:
:返回:
* `Any`: Asgi 对象
Any: Asgi 对象
:异常:
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
ValueError: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
:用法:
@ -133,17 +133,17 @@ def get_bot(self_id: Optional[str] = None) -> Bot:
:参数:
* `self_id: Optional[str]`: 用来识别 Bot 的 ID
self_id: 用来识别 Bot 的 ID
:返回:
* `Bot`: Bot 对象
Bot: Bot 对象
:异常:
* `KeyError`: 对应 ID 的 Bot 不存在
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
* `ValueError`: 没有传入 ID 且没有 Bot 可用
KeyError: 对应 ID 的 Bot 不存在
ValueError: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
ValueError: 没有传入 ID 且没有 Bot 可用
:用法:
@ -169,11 +169,11 @@ def get_bots() -> Dict[str, Bot]:
:返回:
* `Dict[str, Bot]`: 一个以字符串 ID 为键，Bot 对象为值的字典
Dict[str, Bot]: 一个以字符串 ID 为键，Bot 对象为值的字典
:异常:
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
ValueError: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
:用法:
@ -227,8 +227,8 @@ def init(*, _env_file: Optional[str] = None, **kwargs):
:参数:
* `_env_file: Optional[str]`: 配置文件名，默认从 .env.{env_name} 中读取配置
* `**kwargs`: 任意变量，将会存储到 Config 对象里
_env_file: 配置文件名，默认从 .env.{env_name} 中读取配置
**kwargs: 任意变量，将会存储到 Config 对象里
:返回:
@ -269,8 +269,8 @@ def run(*args: Any, **kwargs: Any) -> None:
:参数:
* `*args`: 传入 Driver.run 的位置参数
* `**kwargs`: 传入 Driver.run 的命名参数
*args: 传入 Driver.run 的位置参数
**kwargs: 传入 Driver.run 的命名参数
:返回: