Differences

This shows you the differences between two versions of the page.

--- codingstandard:index [2012-05-18 19:59]
macke
+++ codingstandard:index [2021-06-24 16:35] (current)
kimberly
@@ Line 1: / Line 1: @@
+<WRAP center round important 60%>
+This page has deprecated and will be archived. Please go to [[https://www.bitcraze.io/]].
+</WRAP>
 ====== Coding standard for C ======
 ===== Indentation =====
@@ Line 151: / Line 155: @@
 ==== Macros ====
+<code>
 /** Max count for things */
 #define MAX_COUNT
@@ Line 156: / Line 161: @@
 /** Macro for selecting max value */
 #define MAX(a,b) (a>b?a:b)
+</code>
 ====== Coding standard for Python ======
-What ever works ;-)
+We aim to follow [[http://www.python.org/dev/peps/pep-0008/|PEP-8]] and [[http://www.python.org/dev/peps/pep-0257/|PEP-257]] as much as possible.
+===== Documentation =====
+For documentation doc strings are used.
+===== Static analysis =====
+For static code analysis [[https://pypi.python.org/pypi/flake8|Flake8]] and [[http://www.logilab.org/857|pylint]] are used. For pylint the following exceptions has been made:
+  * These has been added to the list of good variables
+    * pk - used all over for variables that are CRTPPacket
+    * cf - used all over for variables that are Crazyflie
+    * logger - used all over as a file-global logger
+    * cb - used all over to describe an argument or variable that is a callback

Bitcraze Wiki