Mirror/betaflight
1
0
Fork 0
mirror of https://github.com/betaflight/betaflight.git synced 2025-07-16 21:05:35 +03:00
Code Issues Wiki Activity

Merge pull request #11471 from nicovv44/format_CodingStyleReadme

Browse source
This commit is contained in:
J Blackman 2022-03-19 11:06:52 +11:00 • committed by GitHub
commit 2e9d2b1b2b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/development/CodingStyle.md
View file

@ -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 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. Float constants should be defined with "f" suffix, like 1.0f and 3.1415926f, otherwise double conversion might occur.
@ -228,7 +228,7 @@ boolean isBiQuadReady();
## Parameter order ## 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;) 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.: When a group of functions act on an 'object' then that object should be the first parameter for all the functions, e.g.:
@ -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. 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 # Other details