Update README.md

Add colon to TODO and FIXME.
This commit is contained in:
Marc-Antoine Duhaime
2016-03-02 09:42:02 -05:00
parent 246cde0de8
commit 32e3e0f45a

View File

@@ -1550,7 +1550,7 @@ Other Style Guides
}
```
- [17.3](#17.3) <a name='17.3'></a> Prefixing your comments with `FIXME` or `TODO` helps other developers quickly understand if you're pointing out a problem that needs to be revisited, or if you're suggesting a solution to the problem that needs to be implemented. These are different than regular comments because they are actionable. The actions are `FIXME -- need to figure this out` or `TODO -- need to implement`.
- [17.3](#17.3) <a name='17.3'></a> Prefixing your comments with `FIXME` or `TODO` helps other developers quickly understand if you're pointing out a problem that needs to be revisited, or if you're suggesting a solution to the problem that needs to be implemented. These are different than regular comments because they are actionable. The actions are `FIXME: -- need to figure this out` or `TODO: -- need to implement`.
- [17.4](#17.4) <a name='17.4'></a> Use `// FIXME:` to annotate problems.