Update Documentation/DOC-GUIDELINES.md

Co-authored-by: Carlos López <[email protected]>
coconut-svsm · Nov 20, 2023 · 78153c0 · 78153c0
1 parent 9067a9d
commit 78153c0
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/Documentation/DOC-GUIDELINES.md b/Documentation/DOC-GUIDELINES.md
@@ -14,12 +14,11 @@ guidelines for documenting code effectively:
   `//!` and `#[doc = ""]` for documenting fields or expressions.
 
 ```rust
-/// This function does A, takes parameter of type `m`
-/// It returns B, keep in mind C
-fn main(a: m) {
+/// This function does A, takes parameter of type [`M`].
+/// It returns [`B`], keep in mind C
+fn main(a: M) -> B {
      // Some code here
 }
-
 ```
 
 - Documenting trait implementations is optional since the generated