From 32e3e0f45a60aeed038619116548de6ff8197c16 Mon Sep 17 00:00:00 2001 From: Marc-Antoine Duhaime Date: Wed, 2 Mar 2016 09:42:02 -0500 Subject: [PATCH] Update README.md Add colon to TODO and FIXME. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 32068abd..875c1a72 100644 --- a/README.md +++ b/README.md @@ -1550,7 +1550,7 @@ Other Style Guides } ``` - - [17.3](#17.3) 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) 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) Use `// FIXME:` to annotate problems.