From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Juri Linkov Newsgroups: gmane.emacs.bugs Subject: bug#51247: 28.0.60; Insufficient documentation of tab-bar.el internal functions Date: Sun, 17 Oct 2021 21:29:21 +0300 Organization: LINKOV.NET Message-ID: <87tuhfv726.fsf@mail.linkov.net> References: <831r4kghcu.fsf@gnu.org> <87y26ry3vs.fsf@mail.linkov.net> <83mtn7frz3.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="36340"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (x86_64-pc-linux-gnu) Cc: 51247@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Oct 17 20:32:16 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mcAxE-0009Ip-P7 for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 17 Oct 2021 20:32:16 +0200 Original-Received: from localhost ([::1]:34166 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mcAxC-0002jR-O8 for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 17 Oct 2021 14:32:14 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:47154) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mcAx0-0002ix-Kz for bug-gnu-emacs@gnu.org; Sun, 17 Oct 2021 14:32:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:33695) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mcAx0-0001wX-9l for bug-gnu-emacs@gnu.org; Sun, 17 Oct 2021 14:32:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mcAwz-0002d4-NJ for bug-gnu-emacs@gnu.org; Sun, 17 Oct 2021 14:32:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Juri Linkov Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 17 Oct 2021 18:32:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 51247 X-GNU-PR-Package: emacs Original-Received: via spool by 51247-submit@debbugs.gnu.org id=B51247.163449550510084 (code B ref 51247); Sun, 17 Oct 2021 18:32:01 +0000 Original-Received: (at 51247) by debbugs.gnu.org; 17 Oct 2021 18:31:45 +0000 Original-Received: from localhost ([127.0.0.1]:45241 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mcAwj-0002cZ-BF for submit@debbugs.gnu.org; Sun, 17 Oct 2021 14:31:45 -0400 Original-Received: from relay2-d.mail.gandi.net ([217.70.183.194]:59309) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mcAwh-0002cN-3t for 51247@debbugs.gnu.org; Sun, 17 Oct 2021 14:31:44 -0400 Original-Received: (Authenticated sender: juri@linkov.net) by relay2-d.mail.gandi.net (Postfix) with ESMTPSA id 81D9840003; Sun, 17 Oct 2021 18:31:36 +0000 (UTC) In-Reply-To: <83mtn7frz3.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 17 Oct 2021 21:04:16 +0300") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:217430 Archived-At: > (defun tab-bar--current-tab-make (&optional tab) > - ;; `tab' here is an argument meaning "use tab as template". This is > - ;; necessary when switching tabs, otherwise the destination tab > - ;; inherits the current tab's `explicit-name' parameter. > + "Make the current tab data structure from TAB. > +TAB here is an argument meaning \"use tab as template\". This is > +necessary when switching tabs, otherwise the destination tab > +inherits the current tab's `explicit-name' parameter." > > I don't think I understand what do you mean by "use tab as template", > can you explain? Actually, "use tab as template" was not my text, but I improved it anyway, together with all your suggestions. >> [ ] tab-bar-format-tabs >> Show all tabs. >> [X] tab-bar-format-tabs-groups >> Show tabs with their groups. >> [ ] tab-bar-separator >> Separator between tabs. >> [ ] tab-bar-format-add-tab >> Button to add a new tab. >> [X] tab-bar-format-align-right >> Align the rest of tab bar items to the right. >> [X] tab-bar-format-global >> Format ‘global-mode-string’ to display it in the tab bar. More >> [INS] >> >> So here its docstring explains what this option is useful for. > > Can't you provide a separate text for the Custom display? The doc > string in its current form is simply misleading. It's a feature of :options in defcustom that it takes the text from the docstrings. Maybe it's possible to override this text, but I currently don't know how. >> > (defun switch-to-buffer-other-tab (buffer-or-name &optional norecord) >> > "Switch to buffer BUFFER-OR-NAME in another tab. >> > Like \\[switch-to-buffer-other-frame] (which see), but creates a new tab. >> > Interactively, prompt for the buffer to switch to." >> > >> > This command should document the NORECORD argument. >> >> Oops, this was copy/paste from switch-to-buffer, switch-to-buffer-other-window, >> switch-to-buffer-other-frame that all just pass NORECORD down to 'pop-to-buffer'. >> But switch-to-buffer-other-tab doesn't use 'pop-to-buffer'. It uses 'display-buffer' >> that has no NORECORD arg. So this arg should be obsoleted, or maybe deleted right away. > > Fine with me, please use advertised-calling-convention or somesuch to > hide that argument. Done.