Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-11-30 16:36:56 -05:00
Code Issues Projects Releases Packages Wiki Activity

Fix formattings and other issues

Browse source 
See issue 8180.
This commit is contained in:
Tobias Killer 2025-08-09 09:50:36 +02:00
parent 810901e5d6
commit 0cfd755295
25 changed files with 114 additions and 76 deletions
Download patch file Download diff file Expand all files Collapse all files

2
developer/code/coding-style.rst
View file

@ -49,7 +49,7 @@ General typographic conventions
- **Maintain a decent amount of horizontal spacing**, e.g. add a space after ``if`` or before ``{`` in C, and similar in other languages. Whether and where to also use spaces within expressions, such as (x*2+5) vs. (x * 2 + 5) is left to the developer’s judgment. Do not put spaces immediately after or before the brackets in expressions, so avoid constructs like this: ``if ( condition )`` and use ones like this: ``if (condition)`` instead.
- **Use single new lines** (‘\n’ aka LF) in any non-Windows source code. On Windows, exceptionally, use the CRLF line endings (–). This will allow the source code to be easily viewable in various Windows-based programs.
- **Use single new lines** (‘\\n’ aka LF) in any non-Windows source code. On Windows, exceptionally, use the CRLF line endings (–). This will allow the source code to be easily viewable in various Windows-based programs.
- **Use descriptive names for variables and functions**! Really, at a time when most editors have auto-completion features, there is no excuse for using short variable names.