From 099a29aa062bd5ea8567b0905f277896bc78e81d Mon Sep 17 00:00:00 2001
From: Krzysztof Nazarewski <github.com@kdn.im>
Date: Tue, 4 Apr 2023 14:38:05 +0200
Subject: [PATCH] docopt_get_values(): add warning and fix usage

adds message a warning to address #70
---
 docopts.sh | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docopts.sh b/docopts.sh
index 28767e5..e526ee9 100644
--- a/docopts.sh
+++ b/docopts.sh
@@ -94,11 +94,12 @@ docopt_get_version_string() {
 
 # Doc:
 # convert a repeatable option parsed by docopts into a bash 4 ARRAY
+# WARNING: this function does not preserve arguments containing whitespaces
 #   ARGS['FILE,#']=3
 #   ARGS['FILE,0']=somefile1
 #   ARGS['FILE,1']=somefile2
 #   ARGS['FILE,2']=somefile3
-# Usage: myarray=( $(docopt_get_values ARGS FILE") )
+# Usage: myarray=( $(docopt_get_values ARGS FILE) )
 docopt_get_values() {
     local opt=$2
     local ref="\${$1[$opt,#]}"