diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-06 13:27:52 +0100 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-06 13:27:52 +0100 |
| commit | 4f953a35912c3d92c26bcb6c2cc77cc3ced176a3 (patch) | |
| tree | ed006407f7428aaadf68de025c2dafaf1bbeebb7 | |
| parent | e4238e662b26cec586d601b778dec422683b498a (diff) | |
update contributing.md
| -rw-r--r-- | contributing.md | 3 |
1 files changed, 3 insertions, 0 deletions
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> |