ElapsingDreams/LiteyukiBot
1
0
Fork 0
forked from bot/app
Code Pull Requests Activity

📝 修正中文文档中的Liteyuki docstring跳转路径

Browse Source
This commit is contained in:
远野千束 2024-09-01 08:26:47 +08:00 committed by GitHub
parent 5253d0e515
commit 3854376210
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/zh/dev/guide.md
View File

@ -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相关内容： - 文档请遵循[`Markdown`](https://www.markdownguide.org/)语法，并且支持vitepress相关内容：
- 编辑文档时每个语言的文档都要修订。 - 编辑文档时每个语言的文档都要修订。
@ -33,4 +33,4 @@ order: 0
- 请确保**用户文档**是通俗易懂的，**开发文档**是详细的。 - 请确保**用户文档**是通俗易懂的，**开发文档**是详细的。
## 最后 ## 最后
- 本项目是一个非盈利的开源项目，我们欢迎任何人参与开发，你的贡献将会使轻雪变得更好。 - 本项目是一个非盈利的开源项目，我们欢迎任何人参与开发，你的贡献将会使轻雪变得更好。