Improve the docs of a recent change in mb-depth.el
authorEli Zaretskii <eliz@gnu.org>
Fri, 19 Mar 2021 12:46:15 +0000 (14:46 +0200)
committerEli Zaretskii <eliz@gnu.org>
Fri, 19 Mar 2021 12:46:15 +0000 (14:46 +0200)
* 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)

lisp/mb-depth.el

index 3cba6a41f2fcc36a914f0dc76b591dc6a25296fc..88003afb4099ab3146c5fff7fbf8fe0daba9036e 100644 (file)
 ;;; 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)