From dcdf5e6af8ce29af0191102fd43e0d68bbe0fda5 Mon Sep 17 00:00:00 2001 From: Nicolas VERHELST Date: Tue, 15 Mar 2022 17:10:16 +1100 Subject: [PATCH 1/3] Add missing back quotes --- docs/development/CodingStyle.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/CodingStyle.md b/docs/development/CodingStyle.md index 378a364ff7..cd013ef61b 100644 --- a/docs/development/CodingStyle.md +++ b/docs/development/CodingStyle.md @@ -228,7 +228,7 @@ boolean isBiQuadReady(); ## Parameter order -Data should move from right to left, as in memcpy(void *dst, const void *src, size\_t size). +Data should move from right to left, as in `memcpy(void *dst, const void *src, size\_t size)`. This also mimics the assignment operator (e.g. dst = src;) When a group of functions act on an 'object' then that object should be the first parameter for all the functions, e.g.: From f519a089a60d5edcf607cf956625fba722efa234 Mon Sep 17 00:00:00 2001 From: Nicolas VERHELST Date: Tue, 15 Mar 2022 17:14:22 +1100 Subject: [PATCH 2/3] Fix escape --- docs/development/CodingStyle.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/CodingStyle.md b/docs/development/CodingStyle.md index cd013ef61b..d0ca538776 100644 --- a/docs/development/CodingStyle.md +++ b/docs/development/CodingStyle.md @@ -228,7 +228,7 @@ boolean isBiQuadReady(); ## Parameter order -Data should move from right to left, as in `memcpy(void *dst, const void *src, size\_t size)`. +Data should move from right to left, as in `memcpy(void *dst, const void *src, size_t size)`. This also mimics the assignment operator (e.g. dst = src;) When a group of functions act on an 'object' then that object should be the first parameter for all the functions, e.g.: From 17fd27e3a65cbfc4275fddd3007003c4842014c3 Mon Sep 17 00:00:00 2001 From: Nicolas VERHELST Date: Tue, 15 Mar 2022 17:25:22 +1100 Subject: [PATCH 3/3] Add some other back quotes --- docs/development/CodingStyle.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/development/CodingStyle.md b/docs/development/CodingStyle.md index d0ca538776..bc51b8c774 100644 --- a/docs/development/CodingStyle.md +++ b/docs/development/CodingStyle.md @@ -199,7 +199,7 @@ Avoid implicit double conversions and only use float-argument functions. Check .map file to make sure no conversions sneak in, and use -Wdouble-promotion warning for the compiler -Instead of sin() and cos(), use sin\_approx() and cos\_approx() from common/math.h. +Instead of `sin()` and `cos()`, use `sin_approx()` and `cos_approx()` from common/math.h. Float constants should be defined with "f" suffix, like 1.0f and 3.1415926f, otherwise double conversion might occur. @@ -299,7 +299,7 @@ All files must include their own dependencies and not rely on includes from the Do not include things you are not using. -"[#pragma once](https://en.wikipedia.org/wiki/Pragma_once)" is preferred over "#include guards" to avoid multiple includes. +`#pragma once` ([see wiki](https://en.wikipedia.org/wiki/Pragma_once)) is preferred over `#include guards` to avoid multiple includes. # Other details