Re: [Bug] Doc string for org-clock-into-drawer truncated?

[Carsten Dominik <carsten.dominik@gmail.com>]

On Jun 20, 2011, at 9:32 PM, Achim Gratz wrote:

> 
> In org-clock.el, the following definition is found:
> 
> (defcustom org-clock-into-drawer org-log-into-drawer
>  "Should clocking info be wrapped into a drawer?
> When t, clocking info will always be inserted into a :LOGBOOK: drawer.
> If necessary, the drawer will be created.
> When nil, the drawer will not be created, but used when present.
> When an integer and the number of clocking entries in an item
> reaches or exceeds this number, a drawer will be created.
> When a string, it names the drawer to be used.
> 
> The default for this variable is the value of `org-log-into-drawer',
> which see."
> …
> 
> I can't make much sense of the last sentence which looks truncated.

It means, please look at the variable org-log-into-drawer for
more information.  I have seen this idiom in Emacs
in a number of places, so I assumed it is OK.

> 
> As an aside, while the value for org-log-into-drawer can be changed for
> a subtree by setting a property, this setting is not honored for
> clocking in the same subtree, which will still use the value of
> org-log-into-drawer in global or local scope or the LOGBOOK drawer, if
> present.  In org-clock.el:
> 
>      (if org-clock-into-drawer
> 	  (let ((logbook
> 		 (if (stringp org-clock-into-drawer)
> 		     (concat ":" org-clock-into-drawer ":")
> 		   ":LOGBOOK:")))
> 
> But no defun to check a property like that used for logging in org.el:
> 
> (defun org-log-into-drawer ()
>  "Return the value of `org-log-into-drawer', but let properties overrule.
> If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
> used instead of the default value."
>  (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
>    (cond
>     ((or (not p) (equal p "nil")) org-log-into-drawer)
>     ((equal p "t") "LOGBOOK")
>     (t p))))
> 
> For symmetry it seems that one should be able to specify a property
> CLOCK_INTO_DRAWER specifically for clocking or fall back onto LOG_INTO
> DRAWER, just like the customization variables allow one to do.


This does make sense, can you make a patch?

- Carsten