aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormax-001 <maxsmits21@kpnmail.nl>2024-11-05 10:00:16 +0100
committermax-001 <maxsmits21@kpnmail.nl>2024-11-05 10:00:16 +0100
commitb082e63fe81a3650599aef79e4d56d5afb2a731a (patch)
tree020069f5597539965ee7f4be5b65dcdecfdaeb23
parentc4e86c103b6438207ec86a8bb22ac4182d785832 (diff)
Improved example
-rw-r--r--contributing.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/contributing.md b/contributing.md
index 720985e..4c347bb 100644
--- a/contributing.md
+++ b/contributing.md
@@ -69,10 +69,15 @@
```cpp
// Good
// This class handles the rendering process
- class Renderer {};
+ class Renderer {
+ // This method initializes the rendering context
+ void init_context();
+ };
// Bad
- class Renderer {}; // This class handles the rendering process
+ class Renderer {
+ void init_context(); // This method initializes the rendering context
+ };
```
- Formatting nitty-gritty is handled by clang-format/clang-tidy (run `make format` in the root folder of this repository to format all sources files)