diff options
| -rw-r--r-- | contributing.md | 5 |
1 files changed, 1 insertions, 4 deletions
diff --git a/contributing.md b/contributing.md index 695b99b..f6805ac 100644 --- a/contributing.md +++ b/contributing.md @@ -53,12 +53,9 @@ that you can click on to open them. - What is the code supposed to do (optional) - Implementation details (if applicable) - Header files (.h) contain the following types of comments: - - Usage documentation (required) + - <details><summary><a href="#documentation">Usage documentation (required)</a></summary> > [!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> Comments are placed *above* the line(s) they are explaining </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td> |