mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2024-11-30 22:20:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

CODINGSTYLE.md: fix paragraphs in list items

Browse source 
Without an blank line, the pseudo-headers of list items are not
separated from the next paragraph.  An example is rendered as:

    * variable declarations In C code we really ...

instead of intended:

    * variable declarations

      In C code we really ...

Add missing blank lines between paragraphs inside list items and in
between list items to fix the intended rendering.

Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
This commit is contained in:
Andrei Rybak 2023-03-26 18:18:58 +02:00 committed by bstoeger
parent 4e1206d975
commit 7e74dcccca
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CODINGSTYLE.md
View file

@ -86,6 +86,7 @@ other editors that implement this coding style, please add them here.
```
* unfortunate inconsistency
- C code usually uses underscores to structure names
```
variable_in_C
@ -142,6 +143,7 @@ other editors that implement this coding style, please add them here.
## Coding conventions
* variable declarations
In C code we really like them to be at the beginning of a code block,
not interspersed in the middle.
in C++ we are a bit less strict about this - but still, try not to go
@ -193,6 +195,7 @@ other editors that implement this coding style, please add them here.
internally.
* text strings
The default language of subsurface is US English so please use US English
spelling and terminology.
User-visible strings should be passed to the tr() function to enable
@ -257,6 +260,7 @@ other editors that implement this coding style, please add them here.
macro is defined in the "core/gettext.h" header.
* UI text style
These guidelines are designed to ensure consistency in presentation within
Subsurface.
Only the first word of multi-word text strings should be capitalized unless
@ -275,10 +279,14 @@ other editors that implement this coding style, please add them here.
* string manipulation
* user interface
In UI part of the code use of QString methods is preferred, see this pretty
good guide in [QString documentation][1]
* core components
In the core part of the code, C-string should be used.
C-string manipulation is not always straightforward specifically when
it comes to memory allocation, a set of helper functions has been developed