Cleaned Command Line Description Text

Cleaned description text for commands and option arguments
where possible.

Author: tjohnston-softdev

changelog.md

@@ -1,7 +1,17 @@
 # Changelog
 
-**./src/common/sub-interface/**
-* When displaying help on the command line, all command and option descriptions are now lowercase.
-* This affects the files:
-	* cmd-desc.js
-	* option-desc.js
+**./src/common/sub-interface/cmd-desc.js**
+* Added substring breaks to:
+	* 'writeMapDesc' at "and performs..."
+	* 'writeAbsoluteConversionDesc' at "and outputs..."
+	* writeRelativeConversionDesc at "and outputs..."
+
+---
+
+**./src/common/sub-interface/option-desc.js**
+* Split the text of these functions into substrings:
+	* writeIgnoreParseDesc
+	* writeOriginDesc
+* Added substring break to 'writeColourDesc' at "(default:"
+* Wrote new function 'writeSaveImageConvConfigDesc'
+	* Used to assign global variable 'saveImageConvConfigDesc'

src/common/sub-interface/cmd-desc.js

@@ -23,7 +23,8 @@ function writeMapDesc(fileDesc)
 
 	writeRes += "takes ";
 	writeRes += fileDesc;
-	writeRes += ", converts it into an interactive diagram, and performs a pathfinding algorithm.";
+	writeRes += ", converts it into an interactive diagram, ";
+	writeRes += "and performs a pathfinding algorithm.";
 
 	return writeRes;
 }
@@ -35,7 +36,8 @@ function writeAbsoluteConversionDesc(inputDesc)
 
 	writeRes += "takes an existing ";
 	writeRes += inputDesc;
-	writeRes += " file, parses it into a graph, and outputs an absolute definition text file.";
+	writeRes += " file, parses it into a graph, ";
+	writeRes += "and outputs an absolute definition text file.";
 
 	return writeRes;
 }
@@ -47,7 +49,8 @@ function writeRelativeConversionDesc(inputDesc)
 
 	writeRes += "takes an existing ";
 	writeRes += inputDesc;
-	writeRes += " file, parses it into a graph, and outputs a relative definition text file.";
+	writeRes += " file, parses it into a graph, ";
+	writeRes += "and outputs a relative definition text file.";
 
 	return writeRes;
 }

src/common/sub-interface/option-desc.js

@@ -14,13 +14,19 @@ const tileSizeDesc = "the approximate size of a maze tile in pixels. (default: 1
 const imageOriginDescX = writeOriginDesc("x");
 const imageOriginDescY = writeOriginDesc("y");
 const replaceExistingFileDesc = "specifies whether existing files will be replaced.";
-const saveImageConvConfigDesc = "specifies the path where the image configuration file will be saved. if this is blank, no file will be saved.";
+const saveImageConvConfigDesc = writeSaveImageConvConfigDesc();
 
 
 
 function writeIgnoreParseDesc(typeDesc)
 {
-	var writeRes = "ignores or corrects non-fatal errors when parsing input " + typeDesc + " files.";
+	var writeRes = "";
+	
+	writeRes += "ignores or corrects non-fatal errors ";
+	writeRes += "when parsing input ";
+	writeRes += typeDesc;
+	writeRes += " files.";
+	
 	return writeRes;
 }
 
@@ -44,7 +50,8 @@ function writeColourDesc(pixelDesc, defaultHex)
 
 	writeRes += "the hex colour of ";
 	writeRes += pixelDesc;
-	writeRes += " pixels in the target image. (default: ";
+	writeRes += " pixels in the target image. ";
+	writeRes += "(default: ";
 	writeRes += defaultHex;
 	writeRes += ")";
 
@@ -54,7 +61,25 @@ function writeColourDesc(pixelDesc, defaultHex)
 
 function writeOriginDesc(oPlane)
 {
-	var writeRes = "the approximate " + oPlane + " location of the first tile. (default: 0)";
+	var writeRes = "";
+	
+	writeRes += "the approximate ";
+	writeRes += oPlane;
+	writeRes += " location of the first tile. ";
+	writeRes += "(default: 0)";
+	
+	return writeRes;
+}
+
+
+function writeSaveImageConvConfigDesc()
+{
+	var writeRes = "";
+	
+	writeRes += "specifies the path where the ";
+	writeRes += "image configuration file will be saved. ";
+	writeRes += "if this is blank, no file will be saved.";
+	
 	return writeRes;
 }
 

summary.md

@@ -1,12 +1,12 @@
 # Summary
 
-**Version:** 1.0.25
+**Version:** 1.0.26
 
 **Date:** 2021-03-31
 
-**Title:** Lowercase command and option descriptions.
+**Title:** Cleaned Command Line Description Text
 
 **Description:**
 
-When displaying help on the command line, all command and
-option descriptions are now lowercase.
+Cleaned description text for commands and option arguments
+where possible.