summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2021-03-19 14:46:15 +0200
committerEli Zaretskii <eliz@gnu.org>2021-03-19 14:46:15 +0200
commit3af2cee64b86e4ce59adb8e8720d92db35039cbc (patch)
tree42ecd3f628310321e27430a317d654bee2c96279
parent1971a3185f6b3f7c6c627d1c8968bb09a834f9c1 (diff)
downloademacs-3af2cee64b86e4ce59adb8e8720d92db35039cbc.tar.gz
Improve the docs of a recent change in mb-depth.el
* lisp/mb-depth.el (minibuffer-depth-indicator-function): Improve the wording of the doc string and of the label used for the default value. (Bug#47252)
-rw-r--r--lisp/mb-depth.el11
1 files changed, 7 insertions, 4 deletions
diff --git a/lisp/mb-depth.el b/lisp/mb-depth.el
index 3cba6a41f2f..88003afb409 100644
--- a/lisp/mb-depth.el
+++ b/lisp/mb-depth.el
@@ -31,11 +31,14 @@
;;; Code:
(defcustom minibuffer-depth-indicator-function nil
- "If non-nil, function to set up the minibuffer depth indicator.
-It is called with one argument, the minibuffer depth,
-and must return a string."
+ "If non-nil, a function to produce the minibuffer depth indicator.
+The function will be called with one argument, the minibuffer depth,
+and must return a string to display as indication of the minibuffer
+depth.
+If nil, display the depth as a number inside brackets, [NN], with
+the `minibuffer-depth-indicator' face."
:version "28.1"
- :type '(choice (const :tag "Default" nil)
+ :type '(choice (const :tag "Default indicator display, [NN]" nil)
(function))
:group 'minibuffer)