From a36f566f10a9b42a00854f05f29f5a27b6bea406 Mon Sep 17 00:00:00 2001
From: "Alex A. Naanou" <alex.nanou@gmail.com>
Date: Mon, 10 Aug 2020 23:17:10 +0300
Subject: [PATCH] added simple multiline option .doc support...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
---
 ADVANCED.md         | 6 ++++++
 README.md           | 5 ++++-
 argv.js             | 9 ++++++++-
 examples/options.js | 4 +++-
 package.json        | 2 +-
 5 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/ADVANCED.md b/ADVANCED.md
index a5e3794..1e0558d 100644
--- a/ADVANCED.md
+++ b/ADVANCED.md
@@ -162,6 +162,12 @@ to control further parsing and/or execution.
 #### `<option>.doc`
 
 Option/command documentation string used in `-help`.
+```
+doc: <string> | <array-of-strings>,
+```
+
+If an array of strings is given each string will be printed on a separate 
+line.
 
 If this is set to `false` the option will be hidden from `-help`.
 
diff --git a/README.md b/README.md
index 6cfbc74..1e2e0a9 100644
--- a/README.md
+++ b/README.md
@@ -246,7 +246,9 @@ but option context can matter (see: [Active options/commands](#active-optionscom
 
 	// option with a value...
 	'-value': {
-		doc: 'set .x to X',
+		doc: [
+			'set .x to X',
+			'NOTE: .doc can be multiple lines'],
 
 		// 'X' (i.e. VALUE) is used to indicate the option value in -help 
 		// while 'x' (key) is the attribute where the value will be written...
@@ -520,6 +522,7 @@ Options:
                                   (default: some value)
              --flag             - if given set .flag
              --value=X          - set .x to X
+			 					  NOTE: .doc can be multiple lines
                                   (required value)
         -i=INT                  - pass an integer value
              --home=PATH        - set home path
diff --git a/argv.js b/argv.js
index 478c5bf..5855560 100644
--- a/argv.js
+++ b/argv.js
@@ -585,6 +585,11 @@ object.Constructor('Parser', {
 				var val_req = getValue(handler, 'valueRequired')[1]
 				var env = getValue(handler, 'env')[1]
 
+				doc = (doc instanceof Array ?
+						doc
+						: [doc])
+					.map(function(s){
+						return s.replace(/\\\*/g, '*') })
 				var info = [
 					...(req ?
 						['required']
@@ -603,7 +608,9 @@ object.Constructor('Parser', {
 						[`more: .. ${ arg.slice(1) } -h`]
 						: []),
 				].join(', ')
-				return [doc.replace(/\\\*/g, '*'),
+
+				return [
+					...doc,
 					...(info.length > 0 ?
 						['('+ info +')']
 						: [])] }
diff --git a/examples/options.js b/examples/options.js
index b3c7a50..d62ff9a 100644
--- a/examples/options.js
+++ b/examples/options.js
@@ -22,7 +22,9 @@ argv.Parser({
 
 	// option with a value...
 	'-value': {
-		doc: 'set .x to X',
+		doc: [
+			'set .x to X',
+			'NOTE: .doc can be multiple lies'],
 
 		// 'X' (i.e. VALUE) is used to indicate the option value in -help 
 		// while 'x' (key) is the attribute where the value will be written...
diff --git a/package.json b/package.json
index b4af7cd..0f5c11f 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ig-argv",
-  "version": "2.11.5",
+  "version": "2.12.0",
   "description": "simple argv parser",
   "main": "argv.js",
   "scripts": {