From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 21 Oct 2021 18:09:03 +0000 (+0300)
Subject: ; More accurate doc string for 'tab-bar-format'
X-Git-Tag: emacs-28.0.90~224
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=2b7655ca0e36a3de40c0a94eed701277a12ba146;p=emacs.git

; More accurate doc string for 'tab-bar-format'

* lisp/tab-bar.el (tab-bar-format): Make the doc string more
accurate.  (Bug#51247)
---

diff --git a/lisp/tab-bar.el b/lisp/tab-bar.el
index a3316bf4496..10ff57bfd0a 100644
--- a/lisp/tab-bar.el
+++ b/lisp/tab-bar.el
@@ -706,8 +706,13 @@ the formatted tab name to display in the tab bar."
 Every item in the list is a function that returns
 a string, or a list of menu-item elements, or nil.
 Adding a function to the list causes the tab bar to show
-that string, or display a menu with those menu items when
-you click on the tab bar.
+that string, or display a tab button which, when clicked,
+will invoke the command that is the binding of the menu item.
+The menu-item binding of nil will produce a tab clicking
+on which will select that tab.  The menu-item's title is
+displayed as the label of the tab.
+If a function returns nil, it doesn't directly affect the
+tab bar appearance, but can do that by some side-effect.
 If the list ends with `tab-bar-format-align-right' and
 `tab-bar-format-global', then after enabling `display-time-mode'
 (or any other mode that uses `global-mode-string'),