删除说明前缀

nonebot/adapters/_adapter.py

@@ -63,9 +63,7 @@ class Adapter(abc.ABC):
     @abc.abstractmethod
     async def _call_api(self, bot: Bot, api: str, **data) -> Any:
         """
-        :说明:
-
-          ``adapter`` 实际调用 api 的逻辑实现函数，实现该方法以调用 api。
+        ``adapter`` 实际调用 api 的逻辑实现函数，实现该方法以调用 api。
 
         :参数:
 

nonebot/adapters/_bot.py

@@ -27,11 +27,11 @@ class Bot(abc.ABC):
 
     _calling_api_hook: Set[T_CallingAPIHook] = set()
     """
-        :说明: call_api 时执行的函数
+    call_api 时执行的函数
     """
     _called_api_hook: Set[T_CalledAPIHook] = set()
     """
-        :说明: call_api 后执行的函数
+    call_api 后执行的函数
     """
 
     def __init__(self, adapter: "Adapter", self_id: str):
@@ -58,9 +58,7 @@ class Bot(abc.ABC):
 
     async def call_api(self, api: str, **data: Any) -> Any:
         """
-        :说明:
-
-          调用机器人 API 接口，可以通过该函数或直接通过 bot 属性进行调用
+        调用机器人 API 接口，可以通过该函数或直接通过 bot 属性进行调用
 
         :参数:
 
@@ -129,9 +127,7 @@ class Bot(abc.ABC):
         self, event: "Event", message: Union[str, "Message", "MessageSegment"], **kwargs
     ) -> Any:
         """
-        :说明:
-
-          调用机器人基础发送消息接口
+        调用机器人基础发送消息接口
 
         :参数:
 
@@ -144,9 +140,7 @@ class Bot(abc.ABC):
     @classmethod
     def on_calling_api(cls, func: T_CallingAPIHook) -> T_CallingAPIHook:
         """
-        :说明:
-
-          调用 api 预处理。
+        调用 api 预处理。
 
         :参数:
 
@@ -160,9 +154,7 @@ class Bot(abc.ABC):
     @classmethod
     def on_called_api(cls, func: T_CalledAPIHook) -> T_CalledAPIHook:
         """
-        :说明:
-
-          调用 api 后处理。
+        调用 api 后处理。
 
         :参数:
 

nonebot/adapters/_event.py

@@ -16,9 +16,7 @@ class Event(abc.ABC, BaseModel):
     @abc.abstractmethod
     def get_type(self) -> str:
         """
-        :说明:
-
-          获取事件类型的方法，类型通常为 NoneBot 内置的四种类型。
+        获取事件类型的方法，类型通常为 NoneBot 内置的四种类型。
 
         :返回:
 
@@ -30,9 +28,7 @@ class Event(abc.ABC, BaseModel):
     @abc.abstractmethod
     def get_event_name(self) -> str:
         """
-        :说明:
-
-          获取事件名称的方法。
+        获取事件名称的方法。
 
         :返回:
 
@@ -43,9 +39,7 @@ class Event(abc.ABC, BaseModel):
     @abc.abstractmethod
     def get_event_description(self) -> str:
         """
-        :说明:
-
-          获取事件描述的方法，通常为事件具体内容。
+        获取事件描述的方法，通常为事件具体内容。
 
         :返回:
 
@@ -58,9 +52,7 @@ class Event(abc.ABC, BaseModel):
 
     def get_log_string(self) -> str:
         """
-        :说明:
-
-          获取事件日志信息的方法，通常你不需要修改这个方法，只有当希望 NoneBot 隐藏该事件日志时，可以抛出 ``NoLogException`` 异常。
+        获取事件日志信息的方法，通常你不需要修改这个方法，只有当希望 NoneBot 隐藏该事件日志时，可以抛出 ``NoLogException`` 异常。
 
         :返回:
 
@@ -75,9 +67,7 @@ class Event(abc.ABC, BaseModel):
     @abc.abstractmethod
     def get_user_id(self) -> str:
         """
-        :说明:
-
-          获取事件主体 id 的方法，通常是用户 id 。
+        获取事件主体 id 的方法，通常是用户 id 。
 
         :返回:
 
@@ -88,9 +78,7 @@ class Event(abc.ABC, BaseModel):
     @abc.abstractmethod
     def get_session_id(self) -> str:
         """
-        :说明:
-
-          获取会话 id 的方法，用于判断当前事件属于哪一个会话，通常是用户 id、群组 id 组合。
+        获取会话 id 的方法，用于判断当前事件属于哪一个会话，通常是用户 id、群组 id 组合。
 
         :返回:
 
@@ -101,9 +89,7 @@ class Event(abc.ABC, BaseModel):
     @abc.abstractmethod
     def get_message(self) -> "Message":
         """
-        :说明:
-
-          获取事件消息内容的方法。
+        获取事件消息内容的方法。
 
         :返回:
 
@@ -113,9 +99,7 @@ class Event(abc.ABC, BaseModel):
 
     def get_plaintext(self) -> str:
         """
-        :说明:
-
-          获取消息纯文本的方法，通常不需要修改，默认通过 ``get_message().extract_plain_text`` 获取。
+        获取消息纯文本的方法，通常不需要修改，默认通过 ``get_message().extract_plain_text`` 获取。
 
         :返回:
 
@@ -126,9 +110,7 @@ class Event(abc.ABC, BaseModel):
     @abc.abstractmethod
     def is_tome(self) -> bool:
         """
-        :说明:
-
-          获取事件是否与机器人有关的方法。
+        获取事件是否与机器人有关的方法。
 
         :返回:
 

nonebot/adapters/_message.py

@@ -26,11 +26,11 @@ class MessageSegment(Mapping, abc.ABC, Generic[TM]):
 
     type: str
     """
-        - 说明: 消息段类型
+    消息段类型
     """
     data: Dict[str, Any] = field(default_factory=lambda: {})
     """
-        - 说明: 消息段数据
+    消息段数据
     """
 
     @classmethod
@@ -114,10 +114,9 @@ class Message(List[TMS], abc.ABC):
     @classmethod
     def template(cls: Type[TM], format_string: Union[str, TM]) -> MessageTemplate[TM]:
         """
-        :说明:
+        根据创建消息模板, 用法和 ``str.format`` 大致相同, 但是可以输出消息对象, 并且支持以 ``Message`` 对象作为消息模板
 
-          根据创建消息模板, 用法和 ``str.format`` 大致相同, 但是可以输出消息对象, 并且支持以 ``Message`` 对象作为消息模板
-          并且提供了拓展的格式化控制符, 可以用适用于该消息类型的 ``MessageSegment`` 的工厂方法创建消息
+        并且提供了拓展的格式化控制符, 可以用适用于该消息类型的 ``MessageSegment`` 的工厂方法创建消息
 
         :示例:
 
@@ -187,9 +186,7 @@ class Message(List[TMS], abc.ABC):
 
     def append(self: TM, obj: Union[str, TMS]) -> TM:
         """
-        :说明:
-
-          添加一个消息段到消息数组末尾
+        添加一个消息段到消息数组末尾
 
         :参数:
 
@@ -205,9 +202,7 @@ class Message(List[TMS], abc.ABC):
 
     def extend(self: TM, obj: Union[TM, Iterable[TMS]]) -> TM:
         """
-        :说明:
-
-          拼接一个消息数组或多个消息段到消息数组末尾
+        拼接一个消息数组或多个消息段到消息数组末尾
 
         :参数:
 
@@ -222,9 +217,7 @@ class Message(List[TMS], abc.ABC):
 
     def extract_plain_text(self: "Message[MessageSegment]") -> str:
         """
-        :说明:
-
-          提取消息内纯文本消息
+        提取消息内纯文本消息
         """
 
         return "".join(str(seg) for seg in self if seg.is_text())

nonebot/adapters/_template.py

@@ -47,9 +47,7 @@ class MessageTemplate(Formatter, Generic[TF]):
 
     def __init__(self, template, factory=str) -> None:
         """
-        :说明:
-
-          创建一个模板
+        创建一个模板
 
         :参数:
 
@@ -71,9 +69,7 @@ class MessageTemplate(Formatter, Generic[TF]):
 
     def format(self, *args: Any, **kwargs: Any) -> TF:
         """
-        :说明:
-
-          根据模板和参数生成消息对象
+        根据模板和参数生成消息对象
         """
         msg = self.factory()
         if isinstance(self.template, str):