mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-17 19:03:42 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
Changelog-None
This commit is contained in:
Michael Schmoock 2020-03-05 22:42:21 +01:00 committed by Christian Decker
parent 24984ec680
commit f2478e9160
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.editorconfig
View File

@ -10,6 +10,7 @@ trim_trailing_whitespace = true
[{**.c,**.h,Makefile}]
indent_style = tab
indent_size = 8
[**.py]
indent_style = space

16
doc/STYLE.md
View File

@ -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.
When breaking a line with more than 80 characters, align parameters and
arguments like so:
```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