GNU bug report logs - #47117
28.0.50; [PATCH] Update docstring of 'tab-line-tabs-function'

Previous Next

Full log

Message #11 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Gabriel <gabriel376 <at> hotmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Re: bug#47117: 28.0.50; [PATCH] Update docstring of
 'tab-line-tabs-function'
Date: Sat, 13 Mar 2021 19:10:45 -0300

[Message part 1 (text/plain, inline)]

Juri Linkov <juri <at> linkov.net> writes:

>> The user option 'tab-line-tabs-function' on tab-line.el does not mention
>> the possible value of 'tab-line-tabs-buffer-groups', which can difficult
>> the discoverability of this feature for users. This patch update its
>> docstring to mention the missing option, and adds a docstring to the
>> function of same name. Feel free to modify the proposed patch for an
>> improved and clearer docstring version.
>
> Thanks for your patches.  There is only a very small problem:
>
>>  (defun tab-line-tabs-buffer-groups ()
>> +  "Return a list of buffers grouped either
>> +by `tab-line-tabs-buffer-group-function', when set,
>> +or by `tab-line-tabs-buffer-groups'."
>
> The first line of the docstring should be a complete sentence,
> as described in (info "(elisp) Function Documentation")

Here is an updated patch. I used 'tab-line-tabs-window-buffers' and
'tab-line-switch-cycling' as a reference. I appreciate your help, I am
still learning the basic stuff.

[0001-lisp-tab-line.el-Update-docstring-of-tab-line-tabs-f.patch (text/x-diff, attachment)]

Previous Next

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