From 18ee9bcffe4f7f0c2cd6e8980e6bbd56fd1529e6 Mon Sep 17 00:00:00 2001 From: mibi88 <76903855+mibi88@users.noreply.github.com> Date: Sun, 28 Jul 2024 22:05:49 +0200 Subject: [PATCH] Updated styles. --- STYLE.md | 26 ++------------------------ 1 file changed, 2 insertions(+), 24 deletions(-) diff --git a/STYLE.md b/STYLE.md index dc9e7e7..0a58570 100644 --- a/STYLE.md +++ b/STYLE.md @@ -2,32 +2,10 @@ (Mibi88) Fcalva, SlyVTT: What do you think of this? -Wrap the code on 80 columns. Align the wrapped code with the last parantheses, -etc. - -Use curly braces with if, else, while and for statements if they can't hold on a -single line. - -Put the curly braces after if, else, while or for statements and declarations of -procedures on the same line. - -No spaces around parantheses, one space after a comma. - Variables names in sneak_case. -(Mibi88) SlyVTT, Fcalva, should be use a doc generation thing or do we describe -the procedures as I did so far? +Write your procedure name as following: `filename_whatitdoes`. -Document your procedures as following: - -```C -/* procedure_name() - * - * Describe what this procedure does. - * arg1: Describe this argument. If the text is too long, wrap it to the - * next line like this. - * long_name: Describe this argument, and so on. - */ -``` +The procedures are documented using sphinx. Have I forgotten something?