Merge pull request #2789 from reddevilmidzy/todo-fixme

tshepang · web-flow · commit a09075b09b8a · 2026-03-08T20:50:55.000+01:00
Update conventions for TODO and FIXME comments
diff --git a/src/conventions.md b/src/conventions.md
@@ -139,6 +139,8 @@ if foo {
 }
 ```
 
+If you want to leave a note in the codebase, use `// FIXME` instead.
+
 <a id="cio"></a>
 
 ## Using crates from crates.io

Original file line number	Diff line number	Diff line change
`@@ -139,6 +139,8 @@ if foo {`
`139`	`139`	`}`
`140`	`140`	```
`141`	`141`
	`142`	+If you want to leave a note in the codebase, use `// FIXME` instead.
	`143`	`+`
`142`	`144`	`<a id="cio"></a>`
`143`	`145`
`144`	`146`	`## Using crates from crates.io`