From a9242c8daeb259539e602b1eba71245c288574b9 Mon Sep 17 00:00:00 2001 From: Dave Smith Date: Thu, 2 May 2019 13:18:07 -0500 Subject: [PATCH] Improve A.all (#1413) * reword the A.1 rule title * add candidate content for the A.1 rule * make minor improvements to the A.2 note * simplify wording in the first bullet of A.4's Reason --- CppCoreGuidelines.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CppCoreGuidelines.md b/CppCoreGuidelines.md index 75cff6b..6d1eb7e 100644 --- a/CppCoreGuidelines.md +++ b/CppCoreGuidelines.md @@ -19764,7 +19764,7 @@ This section contains ideas about higher-level architectural ideas and libraries Architectural rule summary: -* [A.1: Separate stable from less stable part of code](#Ra-stable) +* [A.1: Separate stable code from less stable code](#Ra-stable) * [A.2: Express potentially reusable parts as a library](#Ra-lib) * [A.4: There should be no cycles among libraries](#Ra-dag) * [???](#???) @@ -19774,9 +19774,9 @@ Architectural rule summary: * [???](#???) * [???](#???) -### A.1: Separate stable from less stable part of code +### A.1: Separate stable code from less stable code -??? +Isolating less stable code facilitates its unit testing, interface improvement, refactoring, and eventual deprecation. ### A.2: Express potentially reusable parts as a library @@ -19785,15 +19785,15 @@ Architectural rule summary: ##### Note A library is a collection of declarations and definitions maintained, documented, and shipped together. -A library could be a set of headers (a "header only library") or a set of headers plus a set of object files. -A library can be statically or dynamically linked into a program, or it may be `#include`d +A library could be a set of headers (a "header-only library") or a set of headers plus a set of object files. +You can statically or dynamically link a library into a program, or you can `#include` a header-only library. ### A.4: There should be no cycles among libraries ##### Reason -* A cycle implies complication of the build process. +* A cycle complicates the build process. * Cycles are hard to understand and may introduce indeterminism (unspecified behavior). ##### Note