Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
gecko0307 committed Mar 14, 2023
1 parent c35777f commit 67938b8
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ DEALINGS IN THE SOFTWARE.
*/
```

#### Documenting and testing
#### Documenting

It is not strictly necessary to document code, but if you do, use [ddoc syntax](https://dlang.org/spec/ddoc.html). Each documented module should be accompanied by a description block (if you don't do that, documentation generators may ignore the module):
```d
Expand All @@ -84,13 +84,15 @@ It is not strictly necessary to document code, but if you do, use [ddoc syntax](
* Description:
* <more in-depth information (optional)>
*
* Copyright: Your Name 2020.
* Copyright: Your Name 2023.
* License: $(LINK2 https://boost.org/LICENSE_1_0.txt, Boost License 1.0).
* Authors: Your Name
*/
module dlib.something.something;
```

#### Testing

It is advisable to write unit tests for new code, if they can be written. Sometimes functionality needs particular external environment or special conditions to run; in these cases tests are not required.

It is recommended to add one `unittest` block per function, method, or class. Test block should be formatted in the following way:
Expand Down

0 comments on commit 67938b8

Please sign in to comment.