From d7a625bedb9e3c55aceff320ee5ba158276cd4de Mon Sep 17 00:00:00 2001 From: Snowykami Date: Sun, 1 Sep 2024 08:27:50 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20=E4=BF=AE=E6=AD=A3=E8=8B=B1=E6=96=87?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E4=B8=AD=E7=9A=84liteyuki=20docstring=20?= =?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/en/dev/guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/dev/guide.md b/docs/en/dev/guide.md index 33d37a0b..f6af536a 100644 --- a/docs/en/dev/guide.md +++ b/docs/en/dev/guide.md @@ -27,7 +27,7 @@ If you need to submit code to the Liteyuki repository, please read the following - Ensure that the code is runnable and harmless. - Ensure that the type hints in the code are correct. - Ensure that the comment style is [`Google Docstring`](https://google.github.io/styleguide/pyguide.html) or - [`Liteyuki Docstring`](https://github.com/LiteyukiStudio/litedoc)(recommended) to ensure that Litedoc can parse and generate documentation correctly. + [`Liteyuki Docstring`](https://github.com/LiteyukiStudio/litedoc?tab=readme-ov-file#liteyuki-docstring)(recommended) to ensure that Litedoc can parse and generate documentation correctly. - If there is a part for ordinary users, ensure that the documentation is complete (each language has corresponding documentation). - The documentation should follow [`Markdown`](https://www.markdownguide.org/) syntax and support vitepress-related content: - Revise the documentation for each language when editing. @@ -35,4 +35,4 @@ If you need to submit code to the Liteyuki repository, please read the following - Ensure that the **User Documentation** is easy to understand and the **Development Documentation** is detailed. ## Finally -- This project is a non-profit open-source project, and we welcome anyone to participate in development. Your contributions will make Liteyuki better. \ No newline at end of file +- This project is a non-profit open-source project, and we welcome anyone to participate in development. Your contributions will make Liteyuki better.