]> code.delx.au - gnu-emacs/commitdiff
Substitute some customization etc. doc strings
authorPaul Eggert <eggert@cs.ucla.edu>
Sun, 2 Aug 2015 07:04:51 +0000 (00:04 -0700)
committerPaul Eggert <eggert@cs.ucla.edu>
Sun, 2 Aug 2015 07:05:25 +0000 (00:05 -0700)
These changes apply substitute-command-keys to some
doc strings that were going through untranslated
when creating customization or other widgets.
* lisp/cus-edit.el (custom-group-value-create):
* lisp/wid-edit.el (widget-default-create):
(widget-push-button-value-create):
Treat the widget tag as a doc string.
* lisp/emacs-lisp/cl-extra.el (cl--describe-class-slot):
Treat the :documentation value as a doc string.
* lisp/wid-edit.el (widget-choose):
Treat the choice names as doc strings.
(widget-default-create): Treat the :doc value as a doc string.
(widget-toggle-value-create): Treat the :on and :off values
as doc strings.
(widget-documentation-string-value-create):
Substitute the doc string.

lisp/cus-edit.el
lisp/emacs-lisp/cl-extra.el
lisp/wid-edit.el

index a8d1c97e37abe9b5e64f61155cc6da3598e297ba..8fea5d85f4dd511c1b3abc0f43f6da3752c79ba0 100644 (file)
@@ -3990,7 +3990,7 @@ If GROUPS-ONLY is non-nil, return only those members that are groups."
         ;; (indent (widget-get widget :indent))
         (prefix (widget-get widget :custom-prefix))
         (buttons (widget-get widget :buttons))
-        (tag (widget-get widget :tag))
+        (tag (substitute-command-keys (widget-get widget :tag)))
         (symbol (widget-value widget))
         (members (custom-group-members symbol
                                        (and (eq custom-buffer-style 'tree)
index 38cc772e8b068f07127b1d815a2cee79e783b159..101864d3721b60c724045c106d1f56620c8e3b86 100644 (file)
@@ -831,7 +831,9 @@ including `cl-block' and `cl-eval-when'."
               (prin1-to-string
                (alist-get :printer (cl--slot-descriptor-props slot)))))
     (when (alist-get :documentation (cl--slot-descriptor-props slot))
-      (concat "\n  " (alist-get :documentation (cl--slot-descriptor-props slot))
+      (concat "\n  "
+              (substitute-command-keys
+               (alist-get :documentation (cl--slot-descriptor-props slot)))
               "\n")))
    "\n"))
 
index f7d8964c9fc78ae8c63a83ce65ad59f9b46b0fca..ac2e981033165e5baca77e59687f86cf2ae84ae1 100644 (file)
@@ -241,7 +241,7 @@ minibuffer."
             (while items
               (setq choice (pop items))
               (when (consp choice)
-                 (let* ((name (car choice))
+                 (let* ((name (substitute-command-keys (car choice)))
                         (function (cdr choice)))
                    (insert (format "%c = %s\n" next-digit name))
                    (define-key map (vector next-digit) function)
@@ -1503,7 +1503,8 @@ The value of the :type attribute should be an unconverted widget type."
                  (insert-char ?\s (widget-get widget :indent))))
               ((eq escape ?t)
                (let ((image (widget-get widget :tag-glyph))
-                     (tag (widget-get widget :tag)))
+                     (tag (substitute-command-keys
+                           (widget-get widget :tag))))
                  (cond (image
                         (widget-image-insert widget (or tag "image") image))
                        (tag
@@ -1515,7 +1516,7 @@ The value of the :type attribute should be an unconverted widget type."
                (let ((doc (widget-get widget :doc)))
                  (when doc
                    (setq doc-begin (point))
-                   (insert doc)
+                   (insert (substitute-command-keys doc))
                    (while (eq (preceding-char) ?\n)
                      (delete-char -1))
                    (insert ?\n)
@@ -1759,7 +1760,7 @@ If END is omitted, it defaults to the length of LIST."
 
 (defun widget-push-button-value-create (widget)
   "Insert text representing the `on' and `off' states."
-  (let* ((tag (or (widget-get widget :tag)
+  (let* ((tag (or (substitute-command-keys (widget-get widget :tag))
                  (widget-get widget :value)))
         (tag-glyph (widget-get widget :tag-glyph))
         (text (concat widget-push-button-prefix
@@ -2167,7 +2168,8 @@ when he invoked the menu."
 (defun widget-toggle-value-create (widget)
   "Insert text representing the `on' and `off' states."
   (let* ((val (widget-value widget))
-        (text (widget-get widget (if val :on :off)))
+        (text (substitute-command-keys
+               (widget-get widget (if val :on :off))))
         (img (widget-image-find
               (widget-get widget (if val :on-glyph :off-glyph)))))
     (widget-image-insert widget (or text "")
@@ -2914,7 +2916,7 @@ link for that string."
 
 (defun widget-documentation-string-value-create (widget)
   ;; Insert documentation string.
-  (let ((doc (widget-value widget))
+  (let ((doc (substitute-command-keys (widget-value widget)))
        (indent (widget-get widget :indent))
        (shown (widget-get (widget-get widget :parent) :documentation-shown))
        (start (point)))