From daf6a4f7863ad82a3545eae4492b1863cb1bcaf0 Mon Sep 17 00:00:00 2001 From: 苏向夜 Date: Sat, 16 Mar 2024 21:29:16 +0800 Subject: feat(doc): add some document fields --- src/infini/doc.py | 2 ++ src/infini/register.py | 10 +++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/src/infini/doc.py b/src/infini/doc.py index 355cbef8..9913309b 100644 --- a/src/infini/doc.py +++ b/src/infini/doc.py @@ -7,6 +7,8 @@ class Annotation(TypedDict, total=False): usage: Optional[str] description: Optional[str] epilog: Optional[str] + var_doc: Dict[str, str] + sub_cmd: Dict[str, str] class Doc: diff --git a/src/infini/register.py b/src/infini/register.py index f0e22ebc..f2e2e6a2 100644 --- a/src/infini/register.py +++ b/src/infini/register.py @@ -71,6 +71,7 @@ class Register: usage: Optional[str] = None, description: Optional[str] = None, epilog: Optional[str] = None, + sub_cmd: Optional[Dict[str, str]] = None, ): """注册一个业务函数""" @@ -91,13 +92,19 @@ class Register: "usage": usage, "description": description, "epilog": epilog, + "sub_cmd": sub_cmd or {}, } return wrapper return decorator def register_textevent( - self, name: str, text: str, *, description: Optional[str] = None + self, + name: str, + text: str, + *, + description: Optional[str] = None, + var_doc: Optional[Dict[str, str]] = None, ): """注册一个文本事件""" self.events[name] = text @@ -105,6 +112,7 @@ class Register: "usage": None, "description": description, "epilog": None, + "var_doc": var_doc or {}, } def register_variable( -- cgit v1.2.3-70-g09d2