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: use dashes instead of hyphens

Browse source 
Similarly to commit 062533d0a (CONTRIBUTING.md: use dashes instead of
hyphens, 2023-01-14), replace hyphens in prose of CODINGSTYLE.md with
dashes to make the rendered Markdown a bit nicer.

Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
This commit is contained in:
Andrei Rybak 2023-03-26 18:23:17 +02:00 committed by bstoeger
parent e130add0c5
commit 35f0a6af3b
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CODINGSTYLE.md
View file

@ -6,7 +6,7 @@ not yet fully consistent to these rules, but following these rules will make
sure that no one yells at you about your patches. sure that no one yells at you about your patches.
We have a script that can be used to reformat code to be reasonably close We have a script that can be used to reformat code to be reasonably close
to these rules; it's in scripts/whitespace.pl - this script requires to these rules; it's in scripts/whitespace.pl – this script requires
clang-format to be installed (which sadly isn't installed by default on clang-format to be installed (which sadly isn't installed by default on
any of our platforms; even on Mac where clang is the default compiler). any of our platforms; even on Mac where clang is the default compiler).
@ -146,7 +146,7 @@ other editors that implement this coding style, please add them here.
In C code we really like them to be at the beginning of a code block, In C code we really like them to be at the beginning of a code block,
not interspersed in the middle. not interspersed in the middle.
in C++ we are a bit less strict about this - but still, try not to go in C++ we are a bit less strict about this – but still, try not to go
crazy. Notably, in C++ the lifetime of a variable often coincides with the crazy. Notably, in C++ the lifetime of a variable often coincides with the
lifetime of a resource (e.g. file) and therefore the variable is defined lifetime of a resource (e.g. file) and therefore the variable is defined
at the place where the resource is needed. at the place where the resource is needed.
@ -298,7 +298,7 @@ other editors that implement this coding style, please add them here.
### Emacs ### Emacs
These lines in your .emacs file should get you fairly close when it comes These lines in your .emacs file should get you fairly close when it comes
to indentation - many of the other rules you have to follow manually to indentation – many of the other rules you have to follow manually
``` ```
;; indentation ;; indentation