From 0d1122def98a7b41c65946b638edeb310f93479a Mon Sep 17 00:00:00 2001
From: Laurens Van Houtven <_@lvh.cc>
Date: Mon, 23 Jun 2014 13:50:51 +0200
Subject: Add note about using C-style vs C++-style comments

---
 docs/development/submitting-patches.rst | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'docs/development')

diff --git a/docs/development/submitting-patches.rst b/docs/development/submitting-patches.rst
index 3eea1dd3..c05f56d1 100644
--- a/docs/development/submitting-patches.rst
+++ b/docs/development/submitting-patches.rst
@@ -123,6 +123,13 @@ Include a space after commas between parameters:
     /* Bad */
     long f(int,char *)
 
+Use C-style ``/* */`` comments instead of C++-style ``//``:
+
+.. code-block:: c
+
+    // Bad
+    /* Good */
+
 Values set by ``#define`` should be assigned the appropriate type. If you see
 this:
 
-- 
cgit v1.2.3