fix the inspector

[rust.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5e74cd9ef0291d815341a149fb253e34a385d8c1..8734242c6c016eac7e806205edf449b71951bf59 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -41,14 +41,17 @@ contains some questionable code itself! Also before making a pull request, pleas
 travis build actually checks for this.
 
 Also please document your lint with a doc comment akin to the following:
-```
-/// **What it does:** Describe what the lint matches.
+```rust
+/// **What it does:** Checks for ... (describe what the lint matches).
 ///
-/// **Why is this bad?** Write the reason for linting the code.
+/// **Why is this bad?** Supply the reason for linting the code.
 ///
-/// **Known problems:** Hopefully none.
+/// **Known problems:** None. (Or describe where it could go wrong.)
 ///
-/// **Example:** Insert a short example if you have one
+/// **Example:**
+/// ```rust
+/// Insert a short example if you have one.
+/// ```
 ```
 
 Our `util/update_wiki.py` script can then add your lint docs to the wiki.