From 038b7fb7051ad3be26c65a9fe6022c8c764edf2b Mon Sep 17 00:00:00 2001 From: Arne Beer Date: Sat, 12 Mar 2022 11:47:42 +0100 Subject: [PATCH] docs: proofread ARCHITECTURE.md --- ARCHITECTURE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index e0fc6594..dc946190 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -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.