GNU bug report logs - #75950
[PATCH] Add new variable tab-bar-format-tab-help-text-function

Previous Next

Package: emacs;

Reported by: Ship Mints <shipmints <at> gmail.com>

Date: Thu, 30 Jan 2025 18:17:02 UTC

Severity: normal

Tags: patch

Fixed in version 31.0.50

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

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 75950 in the body.
You can then email your comments to 75950 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#75950; Package emacs. (Thu, 30 Jan 2025 18:17:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Ship Mints <shipmints <at> gmail.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Thu, 30 Jan 2025 18:17:02 GMT) Full text and rfc822 format available.

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

From: Ship Mints <shipmints <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org, Juri Linkov <juri <at> linkov.net>
Subject: [PATCH] Add new variable tab-bar-format-tab-help-text-function
Date: Thu, 30 Jan 2025 13:14:17 -0500
[Message part 1 (text/plain, inline)]
This variable may be overridden with a user-provided function to
customize help text for tabs displayed on the tab-bar. Help text
is normally shown in the echo area or via tooltips. See the
variable's docstring for arguments passed to a help-text function.

My current implementation, which fully overrides 'tab-bar--format-tab',
uses a function that returns the buffer-list for current tabs, and wc-bl
for others.

Others might find this useful if they depend on help text.

-Stephane
[Message part 2 (text/html, inline)]
[0001-Add-new-variable-tab-bar-format-tab-help-text-functi.patch (application/octet-stream, attachment)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#75950; Package emacs. (Thu, 30 Jan 2025 19:11:01 GMT) Full text and rfc822 format available.

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

From: Juri Linkov <juri <at> linkov.net>
To: Ship Mints <shipmints <at> gmail.com>
Cc: 75950 <at> debbugs.gnu.org
Subject: Re: bug#75950: [PATCH] Add new variable
 tab-bar-format-tab-help-text-function
Date: Thu, 30 Jan 2025 21:07:46 +0200
> This variable may be overridden with a user-provided function to
> customize help text for tabs displayed on the tab-bar. Help text
> is normally shown in the echo area or via tooltips. See the
> variable's docstring for arguments passed to a help-text function.
>
> My current implementation, which fully overrides 'tab-bar--format-tab',
> uses a function that returns the buffer-list for current tabs, and wc-bl
> for others.
>
> Others might find this useful if they depend on help text.

Thanks.

> +(defun tab-bar-format-tab-help-text-default (tab _i current-p)

Is the argument 'current-p' really necessary?
It's easy to check if the argument 'tab' is current
with (eq (car tab) 'current-tab).

The argument 'current-p' was required for group-related functions since
it's harder to get the current group.  But for non-group it's simpler.

> +  (concat (alist-get 'name tab)
> +          (if current-p " (current tab)"
> +            " (click to visit tab)")))

This suffix would be nice only for demonstration purposes,
but in real use this extra text only adds visual clutter.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#75950; Package emacs. (Thu, 30 Jan 2025 19:21:02 GMT) Full text and rfc822 format available.

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

From: Ship Mints <shipmints <at> gmail.com>
To: Juri Linkov <juri <at> linkov.net>
Cc: 75950 <at> debbugs.gnu.org
Subject: Re: bug#75950: [PATCH] Add new variable
 tab-bar-format-tab-help-text-function
Date: Thu, 30 Jan 2025 14:18:37 -0500
[Message part 1 (text/plain, inline)]
Revised patch attached.

On Thu, Jan 30, 2025 at 2:10 PM Juri Linkov <juri <at> linkov.net> wrote:

> > This variable may be overridden with a user-provided function to
> > customize help text for tabs displayed on the tab-bar. Help text
> > is normally shown in the echo area or via tooltips. See the
> > variable's docstring for arguments passed to a help-text function.
> >
> > My current implementation, which fully overrides 'tab-bar--format-tab',
> > uses a function that returns the buffer-list for current tabs, and wc-bl
> > for others.
> >
> > Others might find this useful if they depend on help text.
>
> Thanks.
>
> > +(defun tab-bar-format-tab-help-text-default (tab _i current-p)
>
> Is the argument 'current-p' really necessary?
> It's easy to check if the argument 'tab' is current
> with (eq (car tab) 'current-tab).
>
> The argument 'current-p' was required for group-related functions since
> it's harder to get the current group.  But for non-group it's simpler.
>
> > +  (concat (alist-get 'name tab)
> > +          (if current-p " (current tab)"
> > +            " (click to visit tab)")))
>
> This suffix would be nice only for demonstration purposes,
> but in real use this extra text only adds visual clutter.
>
[Message part 2 (text/html, inline)]
[0001-Add-new-variable-tab-bar-format-tab-help-text-functi.patch (application/octet-stream, attachment)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#75950; Package emacs. (Thu, 30 Jan 2025 19:31:01 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Ship Mints <shipmints <at> gmail.com>
Cc: 75950 <at> debbugs.gnu.org, juri <at> linkov.net
Subject: Re: bug#75950: [PATCH] Add new variable
 tab-bar-format-tab-help-text-function
Date: Thu, 30 Jan 2025 21:30:08 +0200
> From: Ship Mints <shipmints <at> gmail.com>
> Date: Thu, 30 Jan 2025 13:14:17 -0500
> 
> +*** New variable 'tab-bar-format-tab-help-text-function'.
> +
> +This variable may be overridden with a user-provided function to
> +customize help text for tabs displayed on the tab-bar. Help text
> +is normally shown in the echo area or via tooltips. See the
> +variable's docstring for arguments passed to a help-text function.

Thanks, but please leave two spaces between sentences in documentation
and comments, per our conventions.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#75950; Package emacs. (Thu, 30 Jan 2025 19:42:02 GMT) Full text and rfc822 format available.

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

From: Ship Mints <shipmints <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 75950 <at> debbugs.gnu.org, juri <at> linkov.net
Subject: Re: bug#75950: [PATCH] Add new variable
 tab-bar-format-tab-help-text-function
Date: Thu, 30 Jan 2025 14:39:16 -0500
[Message part 1 (text/plain, inline)]
Done. I do aim to make my submissions conformant.

On Thu, Jan 30, 2025 at 2:30 PM Eli Zaretskii <eliz <at> gnu.org> wrote:

> > From: Ship Mints <shipmints <at> gmail.com>
> > Date: Thu, 30 Jan 2025 13:14:17 -0500
> >
> > +*** New variable 'tab-bar-format-tab-help-text-function'.
> > +
> > +This variable may be overridden with a user-provided function to
> > +customize help text for tabs displayed on the tab-bar. Help text
> > +is normally shown in the echo area or via tooltips. See the
> > +variable's docstring for arguments passed to a help-text function.
>
> Thanks, but please leave two spaces between sentences in documentation
> and comments, per our conventions.
>
[Message part 2 (text/html, inline)]
[0001-Add-new-variable-tab-bar-format-tab-help-text-functi.patch (application/octet-stream, attachment)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#75950; Package emacs. (Thu, 30 Jan 2025 19:46:01 GMT) Full text and rfc822 format available.

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

From: Ship Mints <shipmints <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 75950 <at> debbugs.gnu.org, juri <at> linkov.net
Subject: Re: bug#75950: [PATCH] Add new variable
 tab-bar-format-tab-help-text-function
Date: Thu, 30 Jan 2025 14:43:44 -0500
[Message part 1 (text/plain, inline)]
I've added (setq-local sentence-end-double-space t) to
emacs-news-mode-hook. I'll look to automate this in related docstrings and
commits, also.


On Thu, Jan 30, 2025 at 2:39 PM Ship Mints <shipmints <at> gmail.com> wrote:

> Done. I do aim to make my submissions conformant.
>
> On Thu, Jan 30, 2025 at 2:30 PM Eli Zaretskii <eliz <at> gnu.org> wrote:
>
>> > From: Ship Mints <shipmints <at> gmail.com>
>> > Date: Thu, 30 Jan 2025 13:14:17 -0500
>> >
>> > +*** New variable 'tab-bar-format-tab-help-text-function'.
>> > +
>> > +This variable may be overridden with a user-provided function to
>> > +customize help text for tabs displayed on the tab-bar. Help text
>> > +is normally shown in the echo area or via tooltips. See the
>> > +variable's docstring for arguments passed to a help-text function.
>>
>> Thanks, but please leave two spaces between sentences in documentation
>> and comments, per our conventions.
>>
>
[Message part 2 (text/html, inline)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#75950; Package emacs. (Fri, 31 Jan 2025 07:12:02 GMT) Full text and rfc822 format available.

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

From: Juri Linkov <juri <at> linkov.net>
To: Ship Mints <shipmints <at> gmail.com>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 75950 <at> debbugs.gnu.org
Subject: Re: bug#75950: [PATCH] Add new variable
 tab-bar-format-tab-help-text-function
Date: Fri, 31 Jan 2025 09:10:24 +0200
close 75950 31.0.50
thanks

> Done. I do aim to make my submissions conformant.

Thanks, this is pushed as well.




bug marked as fixed in version 31.0.50, send any further explanations to 75950 <at> debbugs.gnu.org and Ship Mints <shipmints <at> gmail.com> Request was from Juri Linkov <juri <at> linkov.net> to control <at> debbugs.gnu.org. (Fri, 31 Jan 2025 07:12:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Fri, 28 Feb 2025 12:24:16 GMT) Full text and rfc822 format available.

This bug report was last modified 114 days ago.

Previous Next


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