qiurui
/
asterinas
mirror of https://github.com/asterinas/asterinas.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a new reference for the recommended Rust API style

This commit is contained in:
Tate, Hongliang Tian 2025-09-27 20:42:59 +08:00 committed by Tate, Hongliang Tian
parent 08e51cc0c8
commit 4471b9fc01
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
book/src/to-contribute/style-guidelines/rust-guidelines.md
View File

@ -10,8 +10,9 @@ including crates, modules, structs, traits, functions, macros, and more.
The use of the `#[warn(missing_docs)]` lint enforces this rule.
Asterinas adheres to the API style guidelines of the Rust community.
The recommended API documentation style can be found at
[How to write documentation - The rustdoc book](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html).
The recommended API documentation style are specified by two official resources:
1. The rustdoc book: [How to write documentation](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html);
2. The Rust RFC book: [API Documentation Conventions](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text).
## Lint Guidelines