From 72095ca7d6e2b316202d963d07065993be0c5f45 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Wed, 6 Nov 2024 12:08:33 +0100
Subject: fix code style

---
 contributing.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'contributing.md')

diff --git a/contributing.md b/contributing.md
index e910dba..e88d0a9 100644
--- a/contributing.md
+++ b/contributing.md
@@ -277,7 +277,7 @@ that you can click on to open them.
 
   ```cpp
   struct Foo {
-    int bar;
+    int bar = 0;
     std::string baz;
   };
   ```
@@ -285,7 +285,7 @@ that you can click on to open them.
 
   ```cpp
   struct Foo {
-    int bar = 0;
+    int bar;
     std::string baz;
   };
   ```
-- 
cgit v1.2.3


From e4238e662b26cec586d601b778dec422683b498a Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Wed, 6 Nov 2024 13:22:17 +0100
Subject: update contributing.md

---
 contributing.md | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'contributing.md')

diff --git a/contributing.md b/contributing.md
index e88d0a9..8ed3b80 100644
--- a/contributing.md
+++ b/contributing.md
@@ -49,10 +49,10 @@ that you can click on to open them.
   class Cars {};
   ```
   </td></tr></table></details>
-- Source files contain the following types of comments:
+- Source files (.cpp, .hpp) contain the following types of comments:
   - What is the code supposed to do (optional)
   - Implementation details (if applicable)
-- Header files contain the following types of comments:
+- Header files (.h) contain the following types of comments:
   - Usage documentation (required)
   - Implementation details (if they affect the header)
   - Design/data structure decisions (if applicable)
@@ -110,7 +110,8 @@ that you can click on to open them.
   ```
   </td></tr></table></details>
 - <details><summary>
-  <code>using namespace</code> may not be used in header files, only in source files.
+  <code>using namespace</code> may not be used in header files (.h, .hpp), only
+  in source files (.cpp).
   </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
 
   example.h:
-- 
cgit v1.2.3


From 4f953a35912c3d92c26bcb6c2cc77cc3ced176a3 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Wed, 6 Nov 2024 13:27:52 +0100
Subject: update contributing.md

---
 contributing.md | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'contributing.md')

diff --git a/contributing.md b/contributing.md
index 8ed3b80..88cba32 100644
--- a/contributing.md
+++ b/contributing.md
@@ -54,6 +54,9 @@ that you can click on to open them.
   - Implementation details (if applicable)
 - Header files (.h) contain the following types of comments:
   - Usage documentation (required)
+
+    > [!NOTE]
+    > Constructors/destructors aren't required to have a `\brief` description
   - Implementation details (if they affect the header)
   - Design/data structure decisions (if applicable)
 - <details><summary>
-- 
cgit v1.2.3