diff options
| author | Laurens Van Houtven <_@lvh.cc> | 2014-06-23 13:50:51 +0200 |
|---|---|---|
| committer | Laurens Van Houtven <_@lvh.cc> | 2014-06-23 13:50:51 +0200 |
| commit | 0d1122def98a7b41c65946b638edeb310f93479a (patch) | |
| tree | e22aa54ecd1692f4a6af7e921a90e7ff4f0074b7 | |
| parent | ed3d15bc669c8ea2c2acbdec6a1da980e8006a92 (diff) | |
| download | cryptography-0d1122def98a7b41c65946b638edeb310f93479a.tar.gz cryptography-0d1122def98a7b41c65946b638edeb310f93479a.tar.bz2 cryptography-0d1122def98a7b41c65946b638edeb310f93479a.zip | |
Add note about using C-style vs C++-style comments
| -rw-r--r-- | docs/development/submitting-patches.rst | 7 |
1 files changed, 7 insertions, 0 deletions
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: |