From 8379899b67a88727447ecedfbb4418cbb524648d Mon Sep 17 00:00:00 2001 From: GuyDev1 <30812132+GuyDev1@users.noreply.github.com> Date: Sat, 2 Jul 2022 13:37:07 +0300 Subject: [PATCH 1/2] Remove redundancy to improve clarity CFN Resources was mentioned twice in a way that was redundant and reduced clarity. --- docs/DESIGN_GUIDELINES.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/DESIGN_GUIDELINES.md b/docs/DESIGN_GUIDELINES.md index 87e7b2c07072d..7f8ce300ba712 100644 --- a/docs/DESIGN_GUIDELINES.md +++ b/docs/DESIGN_GUIDELINES.md @@ -126,8 +126,8 @@ The AWS Construct Library, which is shipped as part of the AWS CDK constructs representing AWS resources. The AWS Construct Library has multiple layers of constructs, beginning -with low-level constructs, which we call _CFN Resources_ (or L1, short for -"level 1") or CFN Resources (short for CloudFormation). These constructs +with low-level constructs, which we call _CFN Resources_ (short for +CloudFormation resources), or L1 (short for "level 1"). These constructs directly represent all resources available in AWS CloudFormation. CFN Resources are periodically generated from the AWS CloudFormation Resource Specification. They are named **Cfn**_Xyz_, where _Xyz_ is name of the From 5409a22a367bb637a1fc298894e04875059cbf1b Mon Sep 17 00:00:00 2001 From: GuyDev1 <30812132+GuyDev1@users.noreply.github.com> Date: Sat, 2 Jul 2022 13:48:34 +0300 Subject: [PATCH 2/2] added missing word for clarity --- docs/DESIGN_GUIDELINES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DESIGN_GUIDELINES.md b/docs/DESIGN_GUIDELINES.md index 7f8ce300ba712..06de3ba407792 100644 --- a/docs/DESIGN_GUIDELINES.md +++ b/docs/DESIGN_GUIDELINES.md @@ -456,7 +456,7 @@ A prop should be *required* only if there is no possible sensible default value that can be provided *or calculated*. Sensible defaults have a tremendous impact on the developer experience. They -offer a quick way to get started with minimal cognitive, but do not limit users +offer a quick way to get started with minimal cognitive load, but do not limit users from harnessing the full power of the resource, and customizing its behavior. > A good way to determine what's the right sensible default is to refer to the