run-with-idle-timer Doc string Question

run-with-idle-timer Doc string Question

[T.V Raman]

What does this line:
Using
SECS <= N is not recommended if this function is invoked from an idle
timer, because FUNCTION will then be called immediately.

in the doc-string for run-with-idle-timer mean?

run-with-idle-timer is an interactive compiled Lisp function in
‘timer.el’.

(run-with-idle-timer SECS REPEAT FUNCTION &rest ARGS)

  Probably introduced at or before Emacs version 19.31.

Perform an action the next time Emacs is idle for SECS seconds.
The action is to call FUNCTION with arguments ARGS.
SECS may be an integer, a floating point number, or the internal
time format returned by, e.g., ‘current-idle-time’.
If Emacs is currently idle, and has been idle for N seconds (N < SECS),
then it will call FUNCTION in SECS - N seconds from now.  Using
SECS <= N is not recommended if this function is invoked from an idle
timer, because FUNCTION will then be called immediately.

If REPEAT is non-nil, do the action each time Emacs has been idle for
exactly SECS seconds (that is, only once for each time Emacs becomes idle).

This function returns a timer object which you can use in ‘cancel-timer’.

[back]


-- 
♉Id: kg:/m/0285kf1  🦮♉

-- 
♉Id: kg:/m/0285kf1  🦮♉

Re: run-with-idle-timer Doc string Question

[Eli Zaretskii]

> From: "T.V Raman" <raman@google.com>
> Date: Fri, 21 Aug 2020 10:06:39 -0700 (PDT)
> 
> What does this line:
> Using
> SECS <= N is not recommended if this function is invoked from an idle
> timer, because FUNCTION will then be called immediately.
> 
> in the doc-string for run-with-idle-timer mean?

Which part of that sentence is unclear?

Re: run-with-idle-timer Doc string Question

[T.V Raman]

The whole sentence I cited. How exactly would one specify sec < n?

Eli Zaretskii writes:
 > > From: "T.V Raman" <raman@google.com>
 > > Date: Fri, 21 Aug 2020 10:06:39 -0700 (PDT)
 > > 
 > > What does this line:
 > > Using
 > > SECS <= N is not recommended if this function is invoked from an idle
 > > timer, because FUNCTION will then be called immediately.
 > > 
 > > in the doc-string for run-with-idle-timer mean?
 > 
 > Which part of that sentence is unclear?

-- 
♉Id: kg:/m/0285kf1  🦮♉

--
♉Id: kg:/m/0285kf1  🦮♉

Re: run-with-idle-timer Doc string Question

[Eli Zaretskii]

> From: "T.V Raman" <raman@google.com>
> Date: Fri, 21 Aug 2020 12:46:48 -0700
> Cc: raman@google.com,
>     emacs-devel@gnu.org
> 
> The whole sentence I cited. How exactly would one specify sec < n?

So you are saying that the sentence is clear, but you don't understand
how such a situation can happen?

Re: run-with-idle-timer Doc string Question

[Narendra Joshi]

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

I think the part that makes it a bit confusing is that we are talking about
calling run-with-idle-timer with a lower value of SECS from an already
executing callback for another run-with-idle-timer.

On Fri, 21 Aug 2020, 21:49 Eli Zaretskii, <eliz@gnu.org> wrote:

> > From: "T.V Raman" <raman@google.com>
> > Date: Fri, 21 Aug 2020 12:46:48 -0700
> > Cc: raman@google.com,
> >     emacs-devel@gnu.org
> >
> > The whole sentence I cited. How exactly would one specify sec < n?
>
> So you are saying that the sentence is clear, but you don't understand
> how such a situation can happen?
>
>

[-- Attachment #2: Type: text/html, Size: 1138 bytes --]

RE: run-with-idle-timer Doc string Question

[Drew Adams]

> I think the part that makes it a bit confusing is
> that we are talking about calling run-with-idle-timer
> with a lower value of SECS from an already executing
> callback for another run-with-idle-timer.

Gee, what could possibly be confusing about that? ;-)

(Especially if we don't say that explicitly.)

Re: run-with-idle-timer Doc string Question

[Narendra Joshi]

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

It took me a long time to arrive at the fact that it is only possible to
know that Emacs has already been idle for SECS seconds when we are
executing a callback for a run-with-idle-timer call with a delay arg of
SECS seconds. The docstring could state this in more detail.

On Fri, 21 Aug 2020, 23:25 Drew Adams, <drew.adams@oracle.com> wrote:

> > I think the part that makes it a bit confusing is
> > that we are talking about calling run-with-idle-timer
> > with a lower value of SECS from an already executing
> > callback for another run-with-idle-timer.
>
> Gee, what could possibly be confusing about that? ;-)
>
> (Especially if we don't say that explicitly.)
>
>
>

[-- Attachment #2: Type: text/html, Size: 987 bytes --]