[elpa] externals/dape 11e5729309 1/2: Updating docs and turning on zap/dash form by default

[ELPA Syncer]

branch: externals/dape
commit 11e572930939b479285344b82447b3bfe3cf8e42
Author: Daniel Pettersson <daniel@dpettersson.net>
Commit: Daniel Pettersson <daniel@dpettersson.net>

    Updating docs and turning on zap/dash form by default
---
 dape.el | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/dape.el b/dape.el
index 056066f717..51d2b3b37f 100644
--- a/dape.el
+++ b/dape.el
@@ -472,6 +472,10 @@ Symbol keys (Used by dape):
   interpretations of the DAP specification.
   See: GDB bug 32090.
 
+Note: The char - carries special meaning when reading options in
+`dape' and therefore should not be used be used as an key.
+See `dape-config-dash-form'.
+
 Connection to Debug Adapter:
 - If command is specified and not port, dape communicates with the
   debug adapter through stdin/stdout.
@@ -511,8 +515,15 @@ Functions and symbols:
                         ((const :tag "Adapter type" :type) string)
                         ((const :tag "Request type launch/attach" :request) 
string)))))
 
-(defcustom dape-config-dash-form-p nil
-  "If ENV PROGRAM ARGS sh like string format is preferred."
+(defcustom dape-config-dash-form t
+  "If non nil store configurations in dash form in `dape-history'.
+With dash form - switches the reader modes from properties and
+values to sh like format ENV PROGRAM ARGS.
+
+This is useful for adapters which follows the
+`:program', `:env' and `:args' convention.
+
+Example: debugpy - ENV=value program arg1 arg2"
   :type 'boolean)
 
 (defcustom dape-default-config-functions
@@ -5081,7 +5092,7 @@ Where ALIST-KEY exists in `dape-configs'."
   "Create string from KEY and POST-EVAL-CONFIG."
   (pcase-let* ((config-diff (dape--config-diff key post-eval-config))
                ((map :env :program :args) config-diff)
-               (zap-form-p (and dape-config-dash-form-p
+               (zap-form-p (and dape-config-dash-form
                                 (or (stringp program)
                                     (and (consp env) (keywordp (car env))
                                          (not args))))))