diff options
author | Jean-Paul Calderone <exarkun@twistedmatrix.com> | 2013-12-28 12:56:15 -0500 |
---|---|---|
committer | Jean-Paul Calderone <exarkun@twistedmatrix.com> | 2013-12-28 12:56:15 -0500 |
commit | 23828690cf20fbf6590c7b19d7eb1b13baef92a2 (patch) | |
tree | 39187fde5815cc479d927b47a3628978cbff7a7e /docs | |
parent | 30f22f1ee19d8ff9df35d2a04b454a8da9af1a89 (diff) | |
parent | b50927e8dba16142205684ff9cdeab8b03d57b50 (diff) | |
download | cryptography-23828690cf20fbf6590c7b19d7eb1b13baef92a2.tar.gz cryptography-23828690cf20fbf6590c7b19d7eb1b13baef92a2.tar.bz2 cryptography-23828690cf20fbf6590c7b19d7eb1b13baef92a2.zip |
Merge remote-tracking branch 'origin/master' into certificates-and-stuff
Diffstat (limited to 'docs')
-rw-r--r-- | docs/contributing.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index 139f7f3b..63c99530 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -136,6 +136,23 @@ Include a space after commas between parameters: // Bad long f(int,char *) +Values set by ``#define`` should be assigned the appropriate type. If you see +this: + +.. code-block:: c + + #define SOME_INTEGER 0x0; + #define SOME_UINTEGER (unsigned int)0x0001; + #define SOME_STRING "hello"; + +...it should be added to the bindings like so: + +.. code-block:: c + + static const int SOME_INTEGER; + static const unsigned int SOME_UINTEGER; + static char *const SOME_STRING; + Documentation ------------- |