删除说明前缀

This commit is contained in:
hemengyang
2022-01-12 18:16:05 +08:00
parent 0e11959347
commit 0099364838
25 changed files with 226 additions and 568 deletions

View File

@ -137,8 +137,7 @@ class Env(BaseConfig):
environment: str = "prod"
"""
:说明:
当前环境名。 NoneBot 将从 ``.env.{environment}`` 文件中加载配置。
当前环境名。 NoneBot 将从 ``.env.{environment}`` 文件中加载配置。
"""
class Config:
@ -160,9 +159,7 @@ class Config(BaseConfig):
# nonebot configs
driver: str = "~fastapi"
"""
:说明:
NoneBot 运行所使用的 ``Driver`` 。继承自 ``nonebot.drivers.Driver`` 。
NoneBot 运行所使用的 ``Driver`` 。继承自 ``nonebot.drivers.Driver`` 。
配置格式为 ``<module>[:<Driver>][+<module>[:<Mixin>]]*``。
@ -170,21 +167,15 @@ class Config(BaseConfig):
"""
host: IPvAnyAddress = IPv4Address("127.0.0.1") # type: ignore
"""
:说明:
NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP/主机名。
NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP/主机名。
"""
port: int = 8080
"""
:说明:
NoneBot 的 HTTP 和 WebSocket 服务端监听的端口。
NoneBot 的 HTTP 和 WebSocket 服务端监听的端口。
"""
log_level: Union[int, str] = "INFO"
"""
:说明:
配置 NoneBot 日志输出等级,可以为 ``int`` 类型等级或等级名称,参考 `loguru 日志等级`_。
配置 NoneBot 日志输出等级,可以为 ``int`` 类型等级或等级名称,参考 `loguru 日志等级`_。
:示例:
@ -200,17 +191,13 @@ class Config(BaseConfig):
# bot connection configs
api_timeout: Optional[float] = 30.0
"""
:说明:
API 请求超时时间,单位: 秒。
API 请求超时时间,单位: 秒。
"""
# bot runtime configs
superusers: Set[str] = set()
"""
:说明:
机器人超级用户。
机器人超级用户。
:示例:
@ -220,27 +207,19 @@ class Config(BaseConfig):
"""
nickname: Set[str] = set()
"""
:说明:
机器人昵称。
机器人昵称。
"""
command_start: Set[str] = {"/"}
"""
:说明:
命令的起始标记,用于判断一条消息是不是命令。
命令的起始标记,用于判断一条消息是不是命令。
"""
command_sep: Set[str] = {"."}
"""
:说明:
命令的分隔标记,用于将文本形式的命令切分为元组(实际的命令名)。
命令的分隔标记,用于将文本形式的命令切分为元组(实际的命令名)。
"""
session_expire_timeout: timedelta = timedelta(minutes=2)
"""
:说明:
等待用户回复的超时时间。
等待用户回复的超时时间。
:示例: