🎨 format docstring

nonebot/adapters/__init__.py

@@ -29,6 +29,7 @@ class BaseBot(abc.ABC):
                  websocket: Optional[WebSocket] = None):
         """
         :参数:
+
           * ``driver: Driver``: Driver 对象
           * ``connection_type: str``: http 或者 websocket
           * ``config: Config``: Config 对象
@@ -62,15 +63,22 @@ class BaseBot(abc.ABC):
                                body: Optional[dict]) -> Union[str, NoReturn]:
         """
         :说明:
+
           检查连接请求是否合法的函数，如果合法则返回当前连接 ``唯一标识符``，通常为机器人 ID；如果不合法则抛出 ``RequestDenied`` 异常。
+
         :参数:
+
           * ``driver: Driver``: Driver 对象
           * ``connection_type: str``: 连接类型
           * ``headers: dict``: 请求头
           * ``body: Optional[dict]``: 请求数据，WebSocket 连接该部分为空
+
         :返回:
+
           - ``str``: 连接唯一标识符
+
         :异常:
+
           - ``RequestDenied``: 请求非法
         """
         raise NotImplementedError
@@ -79,8 +87,11 @@ class BaseBot(abc.ABC):
     async def handle_message(self, message: dict):
         """
         :说明:
+
           处理上报消息的函数，转换为 ``Event`` 事件后调用 ``nonebot.message.handle_event`` 进一步处理事件。
+
         :参数:
+
           * ``message: dict``: 收到的上报消息
         """
         raise NotImplementedError
@@ -89,10 +100,14 @@ class BaseBot(abc.ABC):
     async def call_api(self, api: str, **data):
         """
         :说明:
+
           调用机器人 API 接口，可以通过该函数或直接通过 bot 属性进行调用
+
         :参数:
+
           * ``api: str``: API 名称
           * ``**data``: API 数据
+
         :示例:
 
         .. code-block:: python
@@ -108,8 +123,11 @@ class BaseBot(abc.ABC):
                                   "BaseMessageSegment"], **kwargs):
         """
         :说明:
+
           调用机器人基础发送消息接口
+
         :参数:
+
           * ``event: Event``: 上报事件
           * ``message: Union[str, Message, MessageSegment]``: 要发送的消息
           * ``**kwargs``
@@ -125,6 +143,7 @@ class BaseEvent(abc.ABC):
     def __init__(self, raw_event: dict):
         """
         :参数:
+
           * ``raw_event: dict``: 原始上报消息
         """
         self._raw_event = raw_event
@@ -325,6 +344,7 @@ class BaseMessage(list, abc.ABC):
                  **kwargs):
         """
         :参数:
+
           * ``message: Union[str, dict, list, MessageSegment, Message]``: 消息内容
         """
         super().__init__(*args, **kwargs)
@@ -362,8 +382,11 @@ class BaseMessage(list, abc.ABC):
     def append(self, obj: Union[str, BaseMessageSegment]) -> "BaseMessage":
         """
         :说明:
+
           添加一个消息段到消息数组末尾
+
         :参数:
+
           * ``obj: Union[str, MessageSegment]``: 要添加的消息段
         """
         if isinstance(obj, BaseMessageSegment):
@@ -382,8 +405,11 @@ class BaseMessage(list, abc.ABC):
                          Iterable[BaseMessageSegment]]) -> "BaseMessage":
         """
         :说明:
+
           拼接一个消息数组或多个消息段到消息数组末尾
+
         :参数:
+
           * ``obj: Union[Message, Iterable[MessageSegment]]``: 要添加的消息数组
         """
         for segment in obj:
@@ -393,6 +419,7 @@ class BaseMessage(list, abc.ABC):
     def reduce(self) -> None:
         """
         :说明:
+
           缩减消息数组，即拼接相邻纯文本消息段
         """
         index = 0
@@ -407,6 +434,7 @@ class BaseMessage(list, abc.ABC):
     def extract_plain_text(self) -> str:
         """
         :说明:
+
           提取消息内纯文本消息
         """