diff options
author | Thomas Haller <thaller@redhat.com> | 2016-02-04 16:50:42 +0100 |
---|---|---|
committer | Thomas Haller <thaller@redhat.com> | 2016-02-04 17:59:05 +0100 |
commit | 35c120ee1530370818fe1bbd3fe1a77f10ab8d8e (patch) | |
tree | b8957a76d49f5df31872700387a250169c859bd3 /CONTRIBUTING | |
parent | b5a469a894ea2d09c4934d8966dafcae656aa5a7 (diff) |
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.
Diffstat (limited to 'CONTRIBUTING')
-rw-r--r-- | CONTRIBUTING | 5 |
1 files changed, 1 insertions, 4 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING index 47f93700d..d3ea0ce76 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); |