Skip to content

Commit

Permalink
docs: proofread ARCHITECTURE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nukesor committed Mar 12, 2022
1 parent db0ec34 commit 038b7fb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ PR's are automatically checked for these two and won't be accepted unless everyt

### Comments

1. All functions have to have a doc block.
2. All non-trivial structs have to have doc block.
1. All functions must have a doc block.
2. All non-trivial structs must have a doc block.
3. Rather too many inline comments than too few.
4. Non-trivial complexity should be well documented!
4. Non-trivial code should be well documented!

In general, please add a lot of comments. It makes maintenance, collaboration and reviews MUCH easier.

0 comments on commit 038b7fb

Please sign in to comment.