org-clock-is-active

org-clock-is-active

[Łukasz Stelmach]

Hi.

Please take a look at this.

--8<---------------cut here---------------start------------->8---
(defun org-clock-is-active ()
  "Return non-nil if clock is currently running.
The return value is actually the clock marker."
  (marker-buffer org-clock-marker))
--8<---------------cut here---------------end--------------->8---

Either the docstring is lying or the code does not do what it is said
to. (Or it is too late for me?)

Bug? Feature?

Kind regards,
-- 
Łukasz Stelmach
Samsung R&D Institute Poland
Samsung Electronics

Re: org-clock-is-active

[Bastien]

Hi Łukasz,

l.stelmach@samsung.com (Łukasz Stelmach) writes:

> (defun org-clock-is-active ()
>   "Return non-nil if clock is currently running.
> The return value is actually the clock marker."
>   (marker-buffer org-clock-marker))
>
> Either the docstring is lying or the code does not do what it is said
> to. (Or it is too late for me?)

I don't understand, what is the problem exactly?

-- 
 Bastien

Re: org-clock-is-active

[Łukasz Stelmach]

It was <2013-07-03 śro 19:40>, when Bastien wrote:
> l.stelmach@samsung.com (Łukasz Stelmach) writes:
>
>> (defun org-clock-is-active ()
>>   "Return non-nil if clock is currently running.
>> The return value is actually the clock marker."
>>   (marker-buffer org-clock-marker))
>>
>> Either the docstring is lying or the code does not do what it is said
>> to. (Or it is too late for me?)
>
> I don't understand, what is the problem exactly?

The docstring says the function returns a *marker*. The function does not
return org-clock-marker but only the buffer the clock is ticking in. You
can't:

    (goto-char (org-clock-is-active))

which should be possible according to goto-char's docstring

    (goto-char POSITION)

    Set point to POSITION, a number or *marker*.

This is a minor inaccuracy, however, if you do not browse the code but
only look at functions docstring, you may loose a few minutes.

-- 
Łukasz Stelmach
Samsung R&D Institute Poland
Samsung Electronics

Re: org-clock-is-active

[Bastien]

l.stelmach@samsung.com (Łukasz Stelmach) writes:

> The docstring says the function returns a *marker*. The function does not
> return org-clock-marker but only the buffer the clock is ticking in. You
> can't:
>
>     (goto-char (org-clock-is-active))
>
> which should be possible according to goto-char's docstring
>
>     (goto-char POSITION)
>
>     Set point to POSITION, a number or *marker*.
>
> This is a minor inaccuracy, however, if you do not browse the code but
> only look at functions docstring, you may loose a few minutes.

Got it, fixed, thanks!

-- 
 Bastien