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

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

Browse Source
This commit is contained in:
Snowykami 2024-09-01 08:27:50 +08:00 committed by GitHub
parent 3854376210
commit d7a625bedb
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/en/dev/guide.md
View File

@ -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.
- This project is a non-profit open-source project, and we welcome anyone to participate in development. Your contributions will make Liteyuki better.