mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00
Code Issues Projects Releases Wiki Activity

Substitute some customization etc. doc strings

Browse source 
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.
This commit is contained in:
Paul Eggert 2015-08-02 00:04:51 -07:00
parent 543bb9bc20
commit bd3b426ebb
3 changed files with 12 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
lisp/cus-edit.el
View file

@ -3990,7 +3990,7 @@ If GROUPS-ONLY is non-nil, return only those members that are groups."
;; (indent (widget-get widget :indent)) ;; (indent (widget-get widget :indent))
(prefix (widget-get widget :custom-prefix)) (prefix (widget-get widget :custom-prefix))
(buttons (widget-get widget :buttons)) (buttons (widget-get widget :buttons))
(tag (widget-get widget :tag)) (tag (substitute-command-keys (widget-get widget :tag)))
(symbol (widget-value widget)) (symbol (widget-value widget))
(members (custom-group-members symbol (members (custom-group-members symbol
(and (eq custom-buffer-style 'tree) (and (eq custom-buffer-style 'tree)

4
lisp/emacs-lisp/cl-extra.el
View file

@ -831,7 +831,9 @@ including `cl-block' and `cl-eval-when'."
(prin1-to-string (prin1-to-string
(alist-get :printer (cl--slot-descriptor-props slot))))) (alist-get :printer (cl--slot-descriptor-props slot)))))
(when (alist-get :documentation (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")))
"\n")) "\n"))

14
lisp/wid-edit.el
View file

@ -241,7 +241,7 @@ minibuffer."
(while items (while items
(setq choice (pop items)) (setq choice (pop items))
(when (consp choice) (when (consp choice)
(let* ((name (car choice)) (let* ((name (substitute-command-keys (car choice)))
(function (cdr choice))) (function (cdr choice)))
(insert (format "%c = %s\n" next-digit name)) (insert (format "%c = %s\n" next-digit name))
(define-key map (vector next-digit) function) (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)))) (insert-char ?\s (widget-get widget :indent))))
((eq escape ?t) ((eq escape ?t)
(let ((image (widget-get widget :tag-glyph)) (let ((image (widget-get widget :tag-glyph))
(tag (widget-get widget :tag))) (tag (substitute-command-keys
(widget-get widget :tag))))
(cond (image (cond (image
(widget-image-insert widget (or tag "image") image)) (widget-image-insert widget (or tag "image") image))
(tag (tag
@ -1515,7 +1516,7 @@ The value of the :type attribute should be an unconverted widget type."
(let ((doc (widget-get widget :doc))) (let ((doc (widget-get widget :doc)))
(when doc (when doc
(setq doc-begin (point)) (setq doc-begin (point))
(insert doc) (insert (substitute-command-keys doc))
(while (eq (preceding-char) ?\n) (while (eq (preceding-char) ?\n)
(delete-char -1)) (delete-char -1))
(insert ?\n) (insert ?\n)
@ -1759,7 +1760,7 @@ If END is omitted, it defaults to the length of LIST."
(defun widget-push-button-value-create (widget) (defun widget-push-button-value-create (widget)
"Insert text representing the `on' and `off' states." "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))) (widget-get widget :value)))
(tag-glyph (widget-get widget :tag-glyph)) (tag-glyph (widget-get widget :tag-glyph))
(text (concat widget-push-button-prefix (text (concat widget-push-button-prefix
@ -2167,7 +2168,8 @@ when he invoked the menu."
(defun widget-toggle-value-create (widget) (defun widget-toggle-value-create (widget)
"Insert text representing the `on' and `off' states." "Insert text representing the `on' and `off' states."
(let* ((val (widget-value widget)) (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 (img (widget-image-find
(widget-get widget (if val :on-glyph :off-glyph))))) (widget-get widget (if val :on-glyph :off-glyph)))))
(widget-image-insert widget (or text "") (widget-image-insert widget (or text "")
@ -2914,7 +2916,7 @@ link for that string."
(defun widget-documentation-string-value-create (widget) (defun widget-documentation-string-value-create (widget)
;; Insert documentation string. ;; Insert documentation string.
(let ((doc (widget-value widget)) (let ((doc (substitute-command-keys (widget-value widget)))
(indent (widget-get widget :indent)) (indent (widget-get widget :indent))
(shown (widget-get (widget-get widget :parent) :documentation-shown)) (shown (widget-get (widget-get widget :parent) :documentation-shown))
(start (point))) (start (point)))