aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2013-10-19 20:00:26 -0500
committerPaul Kehrer <paul.l.kehrer@gmail.com>2013-10-19 20:00:26 -0500
commit3ed80ba1c1773a0e45538e432573d91cfb388b0f (patch)
treedfe7ef02b58186a1299c523f43e84a15433e66dd /docs
parenta4444554aca86bb27ecfbedff81759b904bcd7b9 (diff)
downloadcryptography-3ed80ba1c1773a0e45538e432573d91cfb388b0f.tar.gz
cryptography-3ed80ba1c1773a0e45538e432573d91cfb388b0f.tar.bz2
cryptography-3ed80ba1c1773a0e45538e432573d91cfb388b0f.zip
add struct style info to docs
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index b125d1af..fe87ac29 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -65,6 +65,16 @@ Don't name parameters:
// Bad
long f(long x);
+...unless they're inside a struct:
+
+.. code-block:: c
+
+ struct my_struct {
+ char *name;
+ int number;
+ ...;
+ };
+
Don't include stray ``void`` parameters:
.. code-block:: c