aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoropal hart <opal@wowana.me>2019-06-17 03:15:15 +0000
committeropal hart <opal@wowana.me>2019-06-17 03:26:19 +0000
commit0eb6c213fa4635f3ff2976832096436de2809711 (patch)
treee66b19c95fc3c80ffe22e46dd8e09eb360af981e
parent55a8106818781e2eada8d88a6289b29ee96eb287 (diff)
doc: remove code sample from Contributingdevelop
anyone too stupid to read the code shouldn't bother sending me a fucking patchset
-rw-r--r--doc/Contributing45
1 files changed, 3 insertions, 42 deletions
diff --git a/doc/Contributing b/doc/Contributing
index be9c7b4..0f1e10d 100644
--- a/doc/Contributing
+++ b/doc/Contributing
@@ -30,45 +30,6 @@ used for any other difficult code that cannot easily be caught.
Keep functions, variables, and struct definitions to the smallest scope
that you need.
-Read the code for anything you're unsure about. Following is a sample
-code with proper formatting, to give you a general idea of how your code
-should look.
-
-/* Use ANSI C comments only.
- * Code should be self-documenting and describe the "how".
- * Comments should be reserved to describe the "why".
- */
-void function (const char* foo, unsigned bar,
- struct baz quux)
-{
- /* Place declarations at top of scope, one per line */
- int x;
- int y;
- int z = 123;
- (void) quux;
-
-
- /* Braces on same line, no "cuddled else". Braces may be omitted
- * when unnecessary, but when in doubt, include them.
- */
- if (bar < z) {
- y = 1;
- ++z;
- }
- else if (bar > z) {
- y = 2;
- --z;
- }
- else while (( x = do_something(bar) ))
- do_something_else(foo);
-
- switch (y) {
- case 1:
- case 2:
- blah(z);
- break;
- default:
- blah(x);
- break;
- }
-}
+Read the code for anything you're unsure about. Code should be
+self-documenting and describe the "how". Comments should be reserved to
+describe the "why".