From 4a1b47de4583e5e3f16783cc17bddd6d962213ab Mon Sep 17 00:00:00 2001 From: Christof Schulze Date: Thu, 8 Dec 2016 23:56:43 +0100 Subject: [PATCH] docs: dev/basics: add rules for coding guide (#970) * use tabs instead of spaces * use jsonfilter for speed --- docs/dev/basics.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/dev/basics.rst b/docs/dev/basics.rst index 54febc30..2f4d1d89 100644 --- a/docs/dev/basics.rst +++ b/docs/dev/basics.rst @@ -55,4 +55,11 @@ should be considered: - Is the script doing more than just executing external commands? if so, use lua - Is the script parsing/editing json-data? If so, use lua for speed +- When using sh, use jsonfilter instead of json_* functions for speed +Code formatting may sound like a topic for the pedantic, however it helps if +the code in the project is formatted in the same way. The following rules +apply: + +- use tabs instead of spaces +- trailing whitespaces must be eliminated