From 6162a121be29649b70715ce2ebd37bbf8dc0e000 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Br=C3=A4unlich?= <sundowneffect@gmail.com>
Date: Thu, 5 May 2022 16:16:27 +0000
Subject: [PATCH] added caption for each example

---
 content/docs/BestPractices/begin-end/index.md  | 12 ++++++++----
 .../one-statement-per-line/index.md            | 12 ++++++++----
 .../spacing-binary-operators/index.md          | 18 ++++++++++++------
 .../unnecessary-truefalse/index.md             | 12 ++++++++----
 .../BestPractices/variable-naming/index.md     | 18 ++++++++++++------
 5 files changed, 48 insertions(+), 24 deletions(-)

diff --git a/content/docs/BestPractices/begin-end/index.md b/content/docs/BestPractices/begin-end/index.md
index f92bf395..b0eb6867 100644
--- a/content/docs/BestPractices/begin-end/index.md
+++ b/content/docs/BestPractices/begin-end/index.md
@@ -8,7 +8,9 @@ _Created by Microsoft, Described by waldo_
 
 Only use begin..end to enclose [compound statements](https://docs.microsoft.com/en-us/cpp/c-language/compound-statement-c?view=msvc-170#:~:text=A%20compound%20statement%20%28also%20called%20a%20%22block%22%29%20typically,appear%20at%20the%20head%20of%20a%20compound%20statement.).
 
-## Bad code
+## Example 1
+
+### Bad code
 
 ```AL
 if FindSet() then begin
@@ -18,7 +20,7 @@ if FindSet() then begin
 end;
 ```
 
-## Good code
+### Good code
 
 ```AL
 if FindSet() then
@@ -27,7 +29,9 @@ if FindSet() then
     until next() = 0;
 ```
 
-## Bad code
+## Example 2
+
+### Bad code
 
 ```AL
 if IsAssemblyOutputLine then begin
@@ -35,7 +39,7 @@ if IsAssemblyOutputLine then begin
 end;
 ```
 
-## Good code
+### Good code
 
 ```AL
 if IsAssemblyOutputLine then
diff --git a/content/docs/BestPractices/one-statement-per-line/index.md b/content/docs/BestPractices/one-statement-per-line/index.md
index 4bc36b72..822c05c1 100644
--- a/content/docs/BestPractices/one-statement-per-line/index.md
+++ b/content/docs/BestPractices/one-statement-per-line/index.md
@@ -10,26 +10,30 @@ _Created by Microsoft, Described by waldo_
 
 A line of code should not have more than one statement.
 
-## Bad code
+## Example 1
+
+### Bad code
 
 ```al
     if OppEntry.Find('-') then exit;  
 ```
 
-## Good code
+### Good code
 
 ```al
     if OppEntry.Find('-') then   
         exit;  
 ```
 
-## Bad code
+## Example 2
+
+### Bad code
 
 ```al
     TotalCost += Cost; TotalAmt += Amt;  
 ```
 
-## Good code
+### Good code
 
 ```al
     TotalCost += Cost; 
diff --git a/content/docs/BestPractices/spacing-binary-operators/index.md b/content/docs/BestPractices/spacing-binary-operators/index.md
index 32902eae..e0bfaac8 100644
--- a/content/docs/BestPractices/spacing-binary-operators/index.md
+++ b/content/docs/BestPractices/spacing-binary-operators/index.md
@@ -10,37 +10,43 @@ _Created by Microsoft, Described by waldo_
 
 There must be exactly one space character on each side of a binary operator such as = + - AND OR =. The parameter comma operator however, should have a space after the comma.
 
-## Bad code
+## Example 1
+
+### Bad code
 
 ```al
     "Line Discount %" := "Line Discount Amount"/"Line Value"*100;
 ```
 
-## Good code
+### Good code
 
 ```al
     "Line Discount %" := "Line Discount Amount" / "Line Value" * 100;
 ```
 
-## Bad code
+## Example 2
+
+### Bad code
 
 ```al
     StartDate := CalcDate('<+'+Format(Days+i)+'D\>',StartDate);
 ```
 
-## Good code
+### Good code
 
 ```al
     StartDate := CalcDate('<+' + Format(Days + i) + 'D\>', StartDate);
 ```
 
-## Bad code
+## Example 3
+
+### Bad code
 
 ```al
     StartDate:=0D; // Initialize
 ```
 
-## Good code
+### Good code
 
 ```al
     StartDate := 0D; // Initialize
diff --git a/content/docs/BestPractices/unnecessary-truefalse/index.md b/content/docs/BestPractices/unnecessary-truefalse/index.md
index 2950736f..57d6864b 100644
--- a/content/docs/BestPractices/unnecessary-truefalse/index.md
+++ b/content/docs/BestPractices/unnecessary-truefalse/index.md
@@ -9,25 +9,29 @@ _Created by Microsoft, Described by waldo_
 ## Description
 Do not use `true` or `false` keywords unnecessarily if the expression is already an logical expression.
 
-## Bad code
+## Example 1
+
+### Bad code
 
 ```al
     if IsPositive() = true then  
 ```
 
-## Good code
+### Good code
 
 ```al
     if IsPositive() then  
 ```
 
-## Bad code
+## Example 2
+
+### Bad code
 
 ```al
     if Complete <> true then  
 ```
 
-## Good code
+### Good code
 
 ```al
     if not Complete then
diff --git a/content/docs/BestPractices/variable-naming/index.md b/content/docs/BestPractices/variable-naming/index.md
index 3ead389b..290174a0 100644
--- a/content/docs/BestPractices/variable-naming/index.md
+++ b/content/docs/BestPractices/variable-naming/index.md
@@ -16,37 +16,43 @@ Blanks, periods, and other characters (such as parentheses) that would make quot
 
 If a variable is a compound of two or more words or abbreviations, each word or abbreviation should begin with a capital letter.
 
-## Bad code
+## Example 1
+
+### Bad code
 
 ```al
     WIPBuffer: Record "Job WIP Buffer"
 ```
 
-## Good code
+### Good code
 
 ```al
     JobWIPBuffer: Record "Job WIP Buffer"    
 ```
 
-## Bad code
+## Example 2
+
+### Bad code
 
 ```al
     Postline: Codeunit "Gen. Jnl.-Post Line";    
 ```
 
-## Good code
+### Good code
 
 ```al
     GenJnlPostLine: Codeunit "Gen. Jnl.-Post Line";
 ```
 
-## Bad code
+## Example 3
+
+### Bad code
 
 ```al
     "Amount (LCY)": Decimal;    
 ```
 
-## Good code
+### Good code
 
 ```al
     AmountLCY: Decimal;