删除说明前缀

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

@ -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:
"""
:说明:
获取事件是否与机器人有关的方法。
获取事件是否与机器人有关的方法。
:返回: