summaryrefslogtreecommitdiff
path: root/lisp/help.el
diff options
context:
space:
mode:
authorStefan Kangas <stefankangas@gmail.com>2023-09-17 22:56:00 +0200
committerStefan Kangas <stefankangas@gmail.com>2023-09-17 22:56:00 +0200
commitf3a50f6dd84aa4644a167c7b7a2dcde5144e2e5f (patch)
treec57e843678eb82c76369c697ee3a26cb4fb0f4cb /lisp/help.el
parentae983e92838d47f2a42662270b6b23e37eb330a2 (diff)
downloademacs-f3a50f6dd84aa4644a167c7b7a2dcde5144e2e5f.tar.gz
Rename describe-map-tree to help--describe-map-tree
This function should have been made internal in the first place. * lisp/help.el (help--describe-map-tree): Rename from 'describe-map-tree'. Keep old name as an obsolete alias, and update all callers.
Diffstat (limited to 'lisp/help.el')
-rw-r--r--lisp/help.el18
1 files changed, 10 insertions, 8 deletions
diff --git a/lisp/help.el b/lisp/help.el
index a012086a687..3a641ccc1be 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -1468,7 +1468,7 @@ Otherwise, return a new string."
;; in case it is a local variable.
(with-current-buffer orig-buf
;; This is for computing the SHADOWS arg for
- ;; describe-map-tree.
+ ;; help--describe-map-tree.
(setq active-maps (current-active-maps))
(when (boundp name)
(setq this-keymap (and (keymapp (symbol-value name))
@@ -1489,9 +1489,10 @@ Otherwise, return a new string."
;; If this one's not active, get nil.
(let ((earlier-maps
(cdr (memq this-keymap (reverse active-maps)))))
- (describe-map-tree this-keymap t (nreverse earlier-maps)
- nil nil (not include-menus)
- nil nil t))))))))
+ (help--describe-map-tree this-keymap t
+ (nreverse earlier-maps)
+ nil nil (not include-menus)
+ nil nil t))))))))
;; 2. Handle quotes.
((and (eq (text-quoting-style) 'curve)
(or (and (= (following-char) ?\`)
@@ -1521,9 +1522,9 @@ quote characters to use is determined by the variable
(t string)))
(defvar help--keymaps-seen nil)
-(defun describe-map-tree (startmap &optional partial shadow prefix title
- no-menu transl always-title mention-shadow
- buffer)
+(defun help--describe-map-tree (startmap &optional partial shadow prefix title
+ no-menu transl always-title mention-shadow
+ buffer)
"Insert a description of the key bindings in STARTMAP.
This is followed by the key bindings of all maps reachable
through STARTMAP.
@@ -1677,7 +1678,7 @@ Assume that this keymap itself is reached by the sequence of
prefix keys PREFIX (a string or vector).
TRANSL, PARTIAL, SHADOW, NOMENU, MENTION-SHADOW and BUFFER are as
-in `describe-map-tree'."
+in `help--describe-map-tree'."
;; Converted from describe_map in keymap.c.
(let* ((map (keymap-canonicalize map))
(tail map)
@@ -2452,6 +2453,7 @@ the suggested string to use instead. See
#'help-command-error-confusable-suggestions))
(define-obsolete-function-alias 'help-for-help-internal #'help-for-help "28.1")
+(define-obsolete-function-alias 'describe-map-tree #'help--describe-map-tree "30.1")
(provide 'help)