doc: update CONTRIBUTING to no longer allow // FIXME comments
authorThomas Haller <thaller@redhat.com>
Thu, 4 Feb 2016 15:50:42 +0000 (16:50 +0100)
committerThomas Haller <thaller@redhat.com>
Thu, 4 Feb 2016 16:59:05 +0000 (17:59 +0100)
Most of our FIXME/TODO comments are already (rightly) /**/.
Just get rid of this non-obvious inconsistancy in our coding
style.

CONTRIBUTING

index 47f9370..d3ea0ce 100644 (file)
@@ -21,13 +21,10 @@ with #ifdef MY_DEFINE / #endif in the code.
     GOOD: g_strdup (x)
     BAD:  g_strdup(x)
 
-* C-style comments, except for FIXMEs.
+* C-style comments
     GOOD: f(x);  /* comment */
     BAD:  f(x);  // comment
 
-    GOOD: // FIXME: juice the gooblygok
-    BAD:  /* FIXME: juice the gooblygok */
-
 * Keep assignments in the variable declaration area pretty short.
     GOOD: MyObject *object;
     BAD: MyObject *object = complex_and_long_init_function(arg1, arg2, arg3);