From 225f1945f5e40642e95545f47671c757eb08beaf Mon Sep 17 00:00:00 2001 From: Adnn Date: Mon, 21 Sep 2015 11:25:18 +0200 Subject: [PATCH] Fixes minor mistakes in I.8 section * use of "precondition" instead of "postcondition". * typo "and" instead of "are". --- CppCoreGuidelines.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CppCoreGuidelines.md b/CppCoreGuidelines.md index d04db05..812a699 100644 --- a/CppCoreGuidelines.md +++ b/CppCoreGuidelines.md @@ -1201,9 +1201,9 @@ Postconditions related only to internal state belongs in the definition/implemen Ensures(buffer[0]==0); } -**Note**: preconditions can be stated in many ways, including comments, `if`-statements, and `assert()`. This can make them hard to distinguish from ordinary code, hard to update, hard to manipulate by tools, and may have the wrong semantics. +**Note**: postconditions can be stated in many ways, including comments, `if`-statements, and `assert()`. This can make them hard to distinguish from ordinary code, hard to update, hard to manipulate by tools, and may have the wrong semantics. -**Alternative**: Postconditions of the form "this resource must be released" and best expressed by [RAII](#Rr-raii). +**Alternative**: Postconditions of the form "this resource must be released" are best expressed by [RAII](#Rr-raii). Ideally, that `Ensured` should be part of the interface that's not easily done. For now, we place it in the definition (function body).