bug#74773: [PATCH] Elaborate doc string for rcirc-next-active-buffer

bug#74773: [PATCH] Elaborate doc string for rcirc-next-active-buffer

[Scott Bell via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 163 bytes --]

I found the current behavior of rcirc-next-active-buffer surprising in
the case where there is no activity, so I thought it could be described
in the doc string.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Patch file --]
[-- Type: text/x-patch, Size: 906 bytes --]

From b5a3f93c006316d53139bbd308afbf4c70c89289 Mon Sep 17 00:00:00 2001
From: Scott Bell <sctb@me.com>
Date: Tue, 10 Dec 2024 12:02:54 -0700
Subject: [PATCH] ; * lisp/net/rcirc.el (rcirc-next-active-buffer): Doc string

---
 lisp/net/rcirc.el | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el
index c41e2ec153f..33e4008fc0b 100644
--- a/lisp/net/rcirc.el
+++ b/lisp/net/rcirc.el
@@ -2448,7 +2448,8 @@ rcirc-bury-buffers
 
 (defun rcirc-next-active-buffer (arg)
   "Switch to the next rcirc buffer with activity.
-With prefix ARG, go to the next low priority buffer with activity."
+With prefix ARG, go to the next low priority buffer with activity.
+When there are no buffers with activity, bury all rcirc buffers."
   (interactive "P")
   (let* ((pair (rcirc-split-activity rcirc-activity))
          (lopri (car pair))
-- 
2.39.5 (Apple Git-154)

bug#74773: [PATCH] Elaborate doc string for rcirc-next-active-buffer

[Eli Zaretskii]

> Date: Tue, 10 Dec 2024 12:20:04 -0700
> From:  Scott Bell via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> I found the current behavior of rcirc-next-active-buffer surprising in
> the case where there is no activity, so I thought it could be described
> in the doc string.

Leo and Philip, is this okay to install?

> >From b5a3f93c006316d53139bbd308afbf4c70c89289 Mon Sep 17 00:00:00 2001
> From: Scott Bell <sctb@me.com>
> Date: Tue, 10 Dec 2024 12:02:54 -0700
> Subject: [PATCH] ; * lisp/net/rcirc.el (rcirc-next-active-buffer): Doc string
> 
> ---
>  lisp/net/rcirc.el | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el
> index c41e2ec153f..33e4008fc0b 100644
> --- a/lisp/net/rcirc.el
> +++ b/lisp/net/rcirc.el
> @@ -2448,7 +2448,8 @@ rcirc-bury-buffers
>  
>  (defun rcirc-next-active-buffer (arg)
>    "Switch to the next rcirc buffer with activity.
> -With prefix ARG, go to the next low priority buffer with activity."
> +With prefix ARG, go to the next low priority buffer with activity.
> +When there are no buffers with activity, bury all rcirc buffers."
>    (interactive "P")
>    (let* ((pair (rcirc-split-activity rcirc-activity))
>           (lopri (car pair))
> -- 
> 2.39.5 (Apple Git-154)
> 

bug#74773: [PATCH] Elaborate doc string for rcirc-next-active-buffer

[Leo Liu]

> On 11 Dec 2024, at 20:21, Eli Zaretskii <eliz@gnu.org> wrote:
> 
> 
>> 
>> Date: Tue, 10 Dec 2024 12:20:04 -0700
>> From:  Scott Bell via "Bug reports for GNU Emacs,
>> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>> 
>> I found the current behavior of rcirc-next-active-buffer surprising in
>> the case where there is no activity, so I thought it could be described
>> in the doc string.
> 
> Leo and Philip, is this okay to install?

After checking all irc buffers with activity, the next rcirc-next-active-buffer returns you back to the buffer where your work is ie non irc buffers.

So the patch doesn’t add much though harmless.

— Leo

> 
>>> From b5a3f93c006316d53139bbd308afbf4c70c89289 Mon Sep 17 00:00:00 2001
>> From: Scott Bell <sctb@me.com>
>> Date: Tue, 10 Dec 2024 12:02:54 -0700
>> Subject: [PATCH] ; * lisp/net/rcirc.el (rcirc-next-active-buffer): Doc string
>> 
>> ---
>> lisp/net/rcirc.el | 3 ++-
>> 1 file changed, 2 insertions(+), 1 deletion(-)
>> 
>> diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el
>> index c41e2ec153f..33e4008fc0b 100644
>> --- a/lisp/net/rcirc.el
>> +++ b/lisp/net/rcirc.el
>> @@ -2448,7 +2448,8 @@ rcirc-bury-buffers
>> 
>> (defun rcirc-next-active-buffer (arg)
>>   "Switch to the next rcirc buffer with activity.
>> -With prefix ARG, go to the next low priority buffer with activity."
>> +With prefix ARG, go to the next low priority buffer with activity.
>> +When there are no buffers with activity, bury all rcirc buffers."
>>   (interactive "P")
>>   (let* ((pair (rcirc-split-activity rcirc-activity))
>>          (lopri (car pair))
>> --
>> 2.39.5 (Apple Git-154)
>> 

bug#74773: [PATCH] Elaborate doc string for rcirc-next-active-buffer

[Philip Kaludercic]

Leo Liu <sdl.web@gmail.com> writes:

>> On 11 Dec 2024, at 20:21, Eli Zaretskii <eliz@gnu.org> wrote:
>> 
>> 
>>> 
>>> Date: Tue, 10 Dec 2024 12:20:04 -0700
>>> From:  Scott Bell via "Bug reports for GNU Emacs,
>>> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>>> 
>>> I found the current behavior of rcirc-next-active-buffer surprising in
>>> the case where there is no activity, so I thought it could be described
>>> in the doc string.
>> 
>> Leo and Philip, is this okay to install?
>
> After checking all irc buffers with activity, the next rcirc-next-active-buffer returns you back to the buffer where your work is ie non irc buffers.
>
> So the patch doesn’t add much though harmless.

1+

> — Leo
>
>> 
>>>> From b5a3f93c006316d53139bbd308afbf4c70c89289 Mon Sep 17 00:00:00 2001
>>> From: Scott Bell <sctb@me.com>
>>> Date: Tue, 10 Dec 2024 12:02:54 -0700
>>> Subject: [PATCH] ; * lisp/net/rcirc.el (rcirc-next-active-buffer): Doc string
>>> 
>>> ---
>>> lisp/net/rcirc.el | 3 ++-
>>> 1 file changed, 2 insertions(+), 1 deletion(-)
>>> 
>>> diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el
>>> index c41e2ec153f..33e4008fc0b 100644
>>> --- a/lisp/net/rcirc.el
>>> +++ b/lisp/net/rcirc.el
>>> @@ -2448,7 +2448,8 @@ rcirc-bury-buffers
>>> 
>>> (defun rcirc-next-active-buffer (arg)
>>>   "Switch to the next rcirc buffer with activity.
>>> -With prefix ARG, go to the next low priority buffer with activity."
>>> +With prefix ARG, go to the next low priority buffer with activity.
>>> +When there are no buffers with activity, bury all rcirc buffers."
>>>   (interactive "P")
>>>   (let* ((pair (rcirc-split-activity rcirc-activity))
>>>          (lopri (car pair))
>>> --
>>> 2.39.5 (Apple Git-154)
>>> 

bug#74773: [PATCH] Elaborate doc string for rcirc-next-active-buffer

[Eli Zaretskii]

> From: Philip Kaludercic <philipk@posteo.net>
> Cc: Zaretskii Eli <eliz@gnu.org>,  Bell Scott <sctb@me.com>,
>   74773@debbugs.gnu.org
> Date: Wed, 11 Dec 2024 16:31:56 +0000
> 
> Leo Liu <sdl.web@gmail.com> writes:
> 
> >> On 11 Dec 2024, at 20:21, Eli Zaretskii <eliz@gnu.org> wrote:
> >> 
> >> 
> >>> 
> >>> Date: Tue, 10 Dec 2024 12:20:04 -0700
> >>> From:  Scott Bell via "Bug reports for GNU Emacs,
> >>> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> >>> 
> >>> I found the current behavior of rcirc-next-active-buffer surprising in
> >>> the case where there is no activity, so I thought it could be described
> >>> in the doc string.
> >> 
> >> Leo and Philip, is this okay to install?
> >
> > After checking all irc buffers with activity, the next rcirc-next-active-buffer returns you back to the buffer where your work is ie non irc buffers.
> >
> > So the patch doesn’t add much though harmless.
> 
> 1+

Thanks, so I've now installed this on the emacs-30 branch, and I'm
closing this bug.