From b85aab4c0954ce8236a4abe4c62906a8783bb3f9 Mon Sep 17 00:00:00 2001 From: xuzhen Date: Wed, 12 Nov 2025 10:43:16 +0800 Subject: [PATCH] modify documentation guidelines --- guidelines/docs_comments_guidelines_en.md | 5 +++++ guidelines/docs_comments_guidelines_zh_cn.md | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/guidelines/docs_comments_guidelines_en.md b/guidelines/docs_comments_guidelines_en.md index 268c1d9..f47fc9c 100644 --- a/guidelines/docs_comments_guidelines_en.md +++ b/guidelines/docs_comments_guidelines_en.md @@ -49,6 +49,11 @@ Args: - Sub-argument1 or Value1 of Arg2: Description. - Sub-argument2 or Value2 of Arg2: Description. + \*\*kwargs: Description. + + - Key1 (int): Description. + - Key2 (str, optional): Description. Default: ``None``. + Returns: Type, description. diff --git a/guidelines/docs_comments_guidelines_zh_cn.md b/guidelines/docs_comments_guidelines_zh_cn.md index f3376c0..ad8c076 100644 --- a/guidelines/docs_comments_guidelines_zh_cn.md +++ b/guidelines/docs_comments_guidelines_zh_cn.md @@ -49,6 +49,11 @@ Args: - Sub-argument1 or Value1 of Arg2: Description. - Sub-argument2 or Value2 of Arg2: Description. + \*\*kwargs: Description. + + - Key1 (int): Description. + - Key2 (str, optional): Description. Default: ``None``. + Returns: Type, description. -- Gitee