rst: documentation style update

Author: RABijl

doc/sphinx/source/development.rst

@@ -94,6 +94,16 @@ and leaves the diff uncommitted in the working tree.
 used in an interactive rebase session. Both scripts require "clang-format" binary
 present in PATH.
 
+.. note::
+    If the format scripts return an error similar to:
+
+    "UnicodeDecodeError: 'utf-8' codec can't decode byte 0xb3 in position 173310:
+    invalid start byte"
+
+    It is likely that the commit contains a binary file that is erroneously
+    being parsed. One solution is to break out the binary file into a separate
+    commit and later squash it once the formatting is done.
+
 An example emacs configuration to help get the pocl code style correct::
 
   (setq default-tab-width 2)
@@ -193,7 +203,8 @@ Code comments should be done C99 style (so "/\* ... \*/") in C files and C++ sty
 LLVM practises described `here
 <https://llvm.org/docs/CodingStandards.html#doxygen-use-in-documentation-comments>`_.
 Please keep in mind that for C files the Doxygen documentation should be created with "/\*\*"
-but use the "\\" prefix Doxygen commands, e.g. "\\param". It is also possible to
+but use the "\\" prefix Doxygen commands, e.g. "\\param". Preferably parameters
+are documented with "\\p" but "\\param" is also fine. It is also possible to
 generate a Doxygen documentation page by configuring CMake with: `ENABLE_DOXYGEN=YES`
 and then running::