From 3854376210edbc9b2adf9e56a18bb1f901adc3fa Mon Sep 17 00:00:00 2001 From: Snowykami Date: Sun, 1 Sep 2024 08:26:47 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20=E4=BF=AE=E6=AD=A3=E4=B8=AD=E6=96=87?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E4=B8=AD=E7=9A=84`Liteyuki=20docstring`?= =?UTF-8?q?=E8=B7=B3=E8=BD=AC=E8=B7=AF=E5=BE=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/dev/guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/zh/dev/guide.md b/docs/zh/dev/guide.md index 9642a4b7..a884914a 100644 --- a/docs/zh/dev/guide.md +++ b/docs/zh/dev/guide.md @@ -25,7 +25,7 @@ order: 0 - 此外，提交到轻雪仓库的代码，请遵循以下规范： - 请确保代码是可运行的，没有危害的。 - 请确保代码的类型提示是正确的。 - - 请确保注释风格为[`Google Docstring`](https://google.github.io/styleguide/pyguide.html)或[`Liteyuki Docstring`](https://github.com/LiteyukiStudio/litedoc)(推荐)以保证Litedoc能够正确解析并生成文档。 + - 请确保注释风格为[`Google Docstring`](https://google.github.io/styleguide/pyguide.html)或[`Liteyuki Docstring`](https://github.com/LiteyukiStudio/litedoc?tab=readme-ov-file#liteyuki-docstring)(推荐)以保证Litedoc能够正确解析并生成文档。 - 若有面向普通用户部分，请确保文档是完善的(每种语言都有对应的文档)。 - 文档请遵循[`Markdown`](https://www.markdownguide.org/)语法，并且支持vitepress相关内容： - 编辑文档时每个语言的文档都要修订。 @@ -33,4 +33,4 @@ order: 0 - 请确保**用户文档**是通俗易懂的，**开发文档**是详细的。 ## 最后 -- 本项目是一个非盈利的开源项目，我们欢迎任何人参与开发，你的贡献将会使轻雪变得更好。 \ No newline at end of file +- 本项目是一个非盈利的开源项目，我们欢迎任何人参与开发，你的贡献将会使轻雪变得更好。