GNU bug report logs - #51247
28.0.60; Insufficient documentation of tab-bar.el internal functions

Previous Next

Full log

View this message in rfc822 format

From: Juri Linkov <juri <at> linkov.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 51247 <at> debbugs.gnu.org
Subject: bug#51247: 28.0.60; Insufficient documentation of tab-bar.el internal functions
Date: Tue, 19 Oct 2021 22:09:27 +0300

>> You don't need to explain about buttons that drop a menu.
>> This is irrelevant for the description of tab-bar-format.
>> Just imagine there is no tab-bar-format-menu-global
>> that uses own unrelated menu items.
>
> Sorry, that won't fly.  The doc string should explain enough for other
> Lisp programmers to be able to produce buttons that drop down menus.

This is the whole point.  The doc string of this variable is not an
appropriate place to teach Lisp programmers how to produce buttons
that drop down menus.  Or you might as well include the whole
Emacs Lisp Reference Manual in this doc string.

> So please humor me with a detailed enough answer to my questions, I'm
> investing enough energy in this stuff to be entitled to a bit more
> than a couple of dismissive sentences.
>
> We must have a decent doc string for this defcustom.  Please help me
> fix what we have now.

You assumed in the doc string that those menu items as used
to display a menu, whereas in fact those menu items as used
to display tabs and other buttons on the tab bar.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.