doc: point out 8char visual tabs in STYLE.md

ElementsProject · Mar 5, 2020 · 2b8fa7a · 2b8fa7a
1 parent 5c8bfab
commit 2b8fa7a
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -10,6 +10,7 @@ trim_trailing_whitespace = true
 
 [{**.c,**.h,Makefile}]
 indent_style = tab
+indent_size = 8
 
 [**.py]
 indent_style = space

diff --git a/doc/STYLE.md b/doc/STYLE.md
@@ -36,6 +36,22 @@ using early returns or continues, eg:
 }
 ```
 
+## Tabs and indentaion
+
+The C code uses TAB charaters with a visual indentation of 8 whitespaces.
+If you submit code for a review, make sure your editor knows this.
+
+Alsom when breaking a line because of more than 80 characters, use additional
+whitespaces to align parameters and arguments like this when possible:
+
+```C
+static void subtract_received_htlcs(const struct channel *channel,
+				    struct amount_msat *amount)
+```
+
+Note: For more details, the files `.clang-format` and `.editorconfig` are
+located in the projects root directory.
+
 ## Prefer Simple Statements
 
 Notice the statement above uses separate tests, rather than combining