zephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: guidelines: add a note about ascii and emojis 

Add a note about source files encoding and emojis.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
This commit is contained in:
Fabio Baltieri 2024-04-03 08:59:04 +00:00 committed by Carles Cufí
parent 4867c56a51
commit e9dceed173
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/contribute/guidelines.rst
View File

@ -459,6 +459,8 @@ exceptions:
comment, ``//``, is not allowed.
* Use ``/** */`` for doxygen comments that need to appear in the documentation.
* Avoid using binary literals (constants starting with ``0b``).
* Avoid using non-ASCII symbols in code, unless it significantly improves
clarity, avoid emojis in any case.
When there are differences between the guidelines above and the formatting
generated by code formatting tools, the guidelines above take precedence.