Add: Documentation to expected pipeline #33

cpuabuse · Mar 21, 2020 · 42d57db · 42d57db
1 parent c6ffa12
commit 42d57db
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 19 deletions.
diff --git a/test/expected/pipeline.ts b/test/expected/pipeline.ts
@@ -4,48 +4,74 @@
 */
 
 /**
- * .Provide the expected data.
+ * Provide the expected data.
+ */
+
+/**
+ * Carriage return.
  */
 
-// Carriage return
 export const carriageReturnCharacter: string = "\r";
 
-// DEL
+/**
+ * DEL.
+ */
 export const del: string = "^?";
 
-// Manually calculated the result (for 128 to 160)
+/**
+ * Manually calculated result for 128 to 160.
+ */
 export const extendedCharacters: string = "M-^@M-^A";
 
-// Manually calculated the result (for 160 to 255); but only tested 170 to 172
+/**
+ * Manually calculated result for 160 to 255.
+ */
 export const extendedHigher: string = "M-*M-+M-,";
 
-// All of the letters
+/**
+ * All of the letters.
+ */
 export const letters: string = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
 
-// Total anount of letters twice
+/**
+ * Total amount of letters twice.
+ */
 export const lettersCount: number = 52;
 
-// New line or line feed
+/**
+ * New line or line feed.
+ */
 export const lineFeedCharacter: string = "\n";
 
-// Literal numbers
+/**
+ * Literal numbers.
+ */
 export const numbers: string = "0123456789";
 
-// Total amount of numbers
+/**
+ * Total amount of numbers.
+ */
 export const numbersCount: number = 10;
 
-// Number
+/**
+ * List of food with numbers for the
+ */
 export const food: string = `1 Beef
 2 Sugar cane
 3 Beans`;
 
-// Number-nonblank
+/**
+ * Numbered list of animals with blank line for the number-nonblank test.
+ */
 export const animals: string = `1 Dog
 
 2 Cat
+
 3 Snake`;
 
-// SqueezeBlank
+/**
+ * List of insects for squeeze-blank test.
+ */
 export const insects: string = `Grasshoper
 
 Praying Mantis
@@ -59,22 +85,32 @@ Orange^I200^IOrange
 Apple^I250^IRed`;
 
 /**
- * Expected name for test of`processEnds`function.
+ * Expected name for test of `processEnds` function.
  */
 export const fruitList: string = `Apple$
 Orange$`;
 
-// Literal space
+/**
+ * Literal space.
+ */
 export const space: string = " ";
 
-// All of the special characters from 128 to 160
+/**
+ * All of the special characters from 128 to 160.
+ */
 export const specialCharacters: string = "!\"#$%&'()*+,-./:;>=<?@[\\]^_`{|}~";
 
-// Maximum special character minus first 32 characters, 10 numbers, 26 uppercase letters, 26 lowercase letters, and a space.
+/**
+ * Maximum special character minus first 32 characters, 10 numbers, 26 uppercase letters, 26 lowercase letters, and a space.
+ */
 export const specialCharactersCount: number = 127 - 32 - 10 - 26 - 26 - 1;
 
-// Tab character for show-nonprinting
+/*
+ * Tab character for show-nonprinting.
+ */
 export const tabCharacter: string = "\t";
 
-// Above 255
+/**
+ * A string containing a sequence of `M-^?`.
+ */
 export const unicodeCharacter: string = "M-^?M-^?M-^?M-^?M-^?M-^?M-^?";
diff --git a/test/input/pipeline.ts b/test/input/pipeline.ts
@@ -22,6 +22,7 @@ Beans`;
 export const animals: string = `Dog
 
 Cat
+
 Snake`;
 
 // Literal empty string
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,6 +22,7 @@ Beans`; @@
     export const animals: string = `Dog
     Cat
     Snake`;
     // Literal empty string
@@ Expand Down @@