Commit graph

8 commits

Author SHA1 Message Date
Andrei Rybak
4e1206d975 CODINGSTYLE.md: fix indentations in samples
Samples of code in CODINGSTYLE.md are wrapped in triple-backticks to
render them as blocks of code.  For code blocks that are indented within
a list item, Markdown renderer of GitHub treats the leading tab as if it
was four spaces.  Rendered code blocks are formatted in a way that
contradicts the code style written down in prose.

Replace leading tabs in indentation with spaces in blocks of sample code
to render them correctly in Markdown lists.

Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
2023-03-26 18:48:03 +02:00
Quentin Young
dbbb39e0f7 CODINGSTYLE.md: note that macros should be caps'd
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2022-03-27 16:37:10 -07:00
Dirk Hohndel
da953fa18a move GitHub url to the Subsurface org
Instead of using the Subsurface-divelog user on GitHub, we now use an org that
was generously donated to us.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-04-26 16:36:30 -07:00
Dirk Hohndel
ad66297cfd desktop: remove user survey
We have never made good use of the results. Let's just remove it.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2020-04-19 14:27:54 -07:00
Berthold Stoeger
65df9ca7b0 Coding style: PascalCase for classes
Codify our unspoken practice in the coding style document.

Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
2020-02-04 02:17:52 +01:00
jan Iversen
9c0a22ef76 documentation: coding style, existing file names
Existing file names should not be changed without a reason.

Signed-off-by: Jan Iversen <jan@casacondor.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-12-26 10:32:53 -08:00
jan Iversen
0241155e47 documentation: coding style cpp/h names
Add rule about cpp/h names

[Dirk Hohndel: small edits to the rule]

Signed-off-by: Jan Iversen <jan@casacondor.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-12-26 10:32:52 -08:00
jan Iversen
4ef1e9cb28 documentation: coding style.
CodingStyle.md should not be the first file, not the adhere to the
styles.

Rename CodingStyle.md --> CODINGSTYLE.md to follow the standard
of other documents.

Signed-off-by: Jan Iversen <jan@casacondor.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2019-12-26 10:32:52 -08:00
Renamed from CodingStyle.md (Browse further)