emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* org-clock-is-active
@ 2013-07-03 15:33 Łukasz Stelmach
  2013-07-03 17:40 ` org-clock-is-active Bastien
  0 siblings, 1 reply; 4+ messages in thread
From: Łukasz Stelmach @ 2013-07-03 15:33 UTC (permalink / raw)
  To: emacs-orgmode

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: org-clock-is-active
  2013-07-03 15:33 org-clock-is-active Łukasz Stelmach
@ 2013-07-03 17:40 ` Bastien
  2013-07-04  8:27   ` org-clock-is-active Łukasz Stelmach
  0 siblings, 1 reply; 4+ messages in thread
From: Bastien @ 2013-07-03 17:40 UTC (permalink / raw)
  To: Łukasz Stelmach; +Cc: emacs-orgmode

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: org-clock-is-active
  2013-07-03 17:40 ` org-clock-is-active Bastien
@ 2013-07-04  8:27   ` Łukasz Stelmach
  2013-07-04  8:32     ` org-clock-is-active Bastien
  0 siblings, 1 reply; 4+ messages in thread
From: Łukasz Stelmach @ 2013-07-04  8:27 UTC (permalink / raw)
  To: Bastien; +Cc: emacs-orgmode

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: org-clock-is-active
  2013-07-04  8:27   ` org-clock-is-active Łukasz Stelmach
@ 2013-07-04  8:32     ` Bastien
  0 siblings, 0 replies; 4+ messages in thread
From: Bastien @ 2013-07-04  8:32 UTC (permalink / raw)
  To: Łukasz Stelmach; +Cc: emacs-orgmode

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2013-07-04  8:33 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-07-03 15:33 org-clock-is-active Łukasz Stelmach
2013-07-03 17:40 ` org-clock-is-active Bastien
2013-07-04  8:27   ` org-clock-is-active Łukasz Stelmach
2013-07-04  8:32     ` org-clock-is-active Bastien

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).