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