GNU bug report logs - #79918
[PATCH] ; * lisp/emacs-lisp/igc.el: Add docstrings and fix typos

Previous Next

To reply to this bug, email your comments to 79918 AT debbugs.gnu.org.
There is no need to reopen the bug first.

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

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

From: Jeremy Bryant <jb <at> jeremybryant.net>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] ; * lisp/emacs-lisp/igc.el: Add docstrings and fix typos
Date: Sun, 30 Nov 2025 21:30:00 +0000

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

Here is a patch to add docstrings and fix typos.

WDYT?

[0001-lisp-emacs-lisp-igc.el-Add-docstrings-and-fix-typos.patch (text/x-diff, attachment)]

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

From: Helmut Eller <eller.helmut <at> gmail.com>
To: Jeremy Bryant <jb <at> jeremybryant.net>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 79918 <at> debbugs.gnu.org
Subject: Re: bug#79918: [PATCH] ; * lisp/emacs-lisp/igc.el: Add docstrings
 and fix typos
Date: Mon, 01 Dec 2025 08:31:36 +0100

On Sun, Nov 30 2025, Jeremy Bryant wrote:

> Here is a patch to add docstrings and fix typos.
>
> WDYT?
[...]
>  (defun igc--current-idle-time ()
> +  "Current idle time available for GC when idle.
> +See `igc--on-idle'."
>    (let ((idle-time (current-idle-time)))
>      (if idle-time (float-time idle-time) 0)))

The idea is that igc--current-idle-time is the time (in seconds as
float) since the last command finished.  Other timers or process-filters
are ignored; that's not ideal but easily available.

>  (defun igc--predict-idle-time ()
> +  "Predict Emacs idle time available for GC when idle, using simple heuristics.
> +See `igc--on-idle'."
>    (* (igc--current-idle-time) 0.80))

This predicts the time until the next command starts.

The rest LGTM.

Helmut

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

From: Jeremy Bryant <jb <at> jeremybryant.net>
To: Helmut Eller <eller.helmut <at> gmail.com>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 79918 <at> debbugs.gnu.org
Subject: Re: bug#79918: [PATCH] ; * lisp/emacs-lisp/igc.el: Add docstrings
 and fix typos
Date: Mon, 01 Dec 2025 21:13:39 +0000

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

Helmut Eller <eller.helmut <at> gmail.com> writes:

> On Sun, Nov 30 2025, Jeremy Bryant wrote:
>
>> Here is a patch to add docstrings and fix typos.
>>
>> WDYT?
> [...]
>>  (defun igc--current-idle-time ()
>> +  "Current idle time available for GC when idle.
>> +See `igc--on-idle'."
>>    (let ((idle-time (current-idle-time)))
>>      (if idle-time (float-time idle-time) 0)))
>
> The idea is that igc--current-idle-time is the time (in seconds as
> float) since the last command finished.  Other timers or process-filters
> are ignored; that's not ideal but easily available.
>
>>  (defun igc--predict-idle-time ()
>> +  "Predict Emacs idle time available for GC when idle, using simple heuristics.
>> +See `igc--on-idle'."
>>    (* (igc--current-idle-time) 0.80))
>
> This predicts the time until the next command starts.
>
> The rest LGTM.
>
> Helmut

OK, thanks Helmut, incorporating suggestions into the attached patch.

[0001-lisp-emacs-lisp-igc.el-Add-docstrings-and-fix-typos.patch (text/x-diff, attachment)]

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

From: Helmut Eller <eller.helmut <at> gmail.com>
To: Jeremy Bryant <jb <at> jeremybryant.net>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 79918 <at> debbugs.gnu.org
Subject: Re: bug#79918: [PATCH] ; * lisp/emacs-lisp/igc.el: Add docstrings
 and fix typos
Date: Wed, 03 Dec 2025 10:55:25 +0100

On Mon, Dec 01 2025, Jeremy Bryant wrote:

> Helmut Eller <eller.helmut <at> gmail.com> writes:
>
>> On Sun, Nov 30 2025, Jeremy Bryant wrote:
>>
>>> Here is a patch to add docstrings and fix typos.
>>>
>>> WDYT?
>> [...]
>>>  (defun igc--current-idle-time ()
>>> +  "Current idle time available for GC when idle.
>>> +See `igc--on-idle'."
>>>    (let ((idle-time (current-idle-time)))
>>>      (if idle-time (float-time idle-time) 0)))
>>
>> The idea is that igc--current-idle-time is the time (in seconds as
>> float) since the last command finished.  Other timers or process-filters
>> are ignored; that's not ideal but easily available.
>>
>>>  (defun igc--predict-idle-time ()
>>> +  "Predict Emacs idle time available for GC when idle, using simple heuristics.
>>> +See `igc--on-idle'."
>>>    (* (igc--current-idle-time) 0.80))
>>
>> This predicts the time until the next command starts.
>>
>> The rest LGTM.
>>
>> Helmut
>
> OK, thanks Helmut, incorporating suggestions into the attached patch.

👍

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

From: Jeremy Bryant <jb <at> jeremybryant.net>
To: Helmut Eller <eller.helmut <at> gmail.com>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 79918 <at> debbugs.gnu.org
Subject: Re: bug#79918: [PATCH] ; * lisp/emacs-lisp/igc.el: Add docstrings
 and fix typos
Date: Fri, 05 Dec 2025 23:03:58 +0000

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

Helmut Eller <eller.helmut <at> gmail.com> writes:

> On Mon, Dec 01 2025, Jeremy Bryant wrote:
>
>> Helmut Eller <eller.helmut <at> gmail.com> writes:
>>>
>>> The rest LGTM.
>>>
>>> Helmut
>>
>> OK, thanks Helmut, incorporating suggestions into the attached patch.
>
> 👍

Thanks Helmut, so now I've just added a reference to the bug number in the
commit, as a minor revision to the commit.

Would you like to merge it to feature/igc?

[0001-lisp-emacs-lisp-igc.el-Add-docstrings-and-fix-typos.patch (text/x-diff, attachment)]

Message #22 received at 79918-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Jeremy Bryant <jb <at> jeremybryant.net>
Cc: eller.helmut <at> gmail.com, 79918-done <at> debbugs.gnu.org
Subject: Re: bug#79918: [PATCH] ; * lisp/emacs-lisp/igc.el: Add docstrings
 and fix typos
Date: Sat, 06 Dec 2025 15:17:23 +0200

> From: Jeremy Bryant <jb <at> jeremybryant.net>
> Cc: 79918 <at> debbugs.gnu.org,  Eli Zaretskii <eliz <at> gnu.org>
> Date: Fri, 05 Dec 2025 23:03:58 +0000
> 
> Helmut Eller <eller.helmut <at> gmail.com> writes:
> 
> > On Mon, Dec 01 2025, Jeremy Bryant wrote:
> >
> >> Helmut Eller <eller.helmut <at> gmail.com> writes:
> >>>
> >>> The rest LGTM.
> >>>
> >>> Helmut
> >>
> >> OK, thanks Helmut, incorporating suggestions into the attached patch.
> >
> > 👍
> 
> Thanks Helmut, so now I've just added a reference to the bug number in the
> commit, as a minor revision to the commit.
> 
> Would you like to merge it to feature/igc?

Helmut did, so I'm closing this bug.

Previous Next

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