From 35c120ee1530370818fe1bbd3fe1a77f10ab8d8e Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Thu, 4 Feb 2016 16:50:42 +0100 Subject: [PATCH] doc: update CONTRIBUTING to no longer allow // FIXME comments Most of our FIXME/TODO comments are already (rightly) /**/. Just get rid of this non-obvious inconsistancy in our coding style. --- CONTRIBUTING | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index 47f93700d0..d3ea0ce765 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -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);