emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ian Barton <lists@wilkesley.net>
To: emacs-orgmode@gnu.org
Subject: Re: [Bug] Doc string for org-clock-into-drawer truncated?
Date: Tue, 21 Jun 2011 10:18:28 +0100	[thread overview]
Message-ID: <4E0061E4.5070704@wilkesley.net> (raw)
In-Reply-To: <875E1ACA-B404-4783-95B3-3EAE52759E0C@gmail.com>

On 21/06/11 08:49, Carsten Dominik wrote:
>
> 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.
>

I agree with Achim, that idiom makes no sense to a native English 
speaker. To make sense it should say something like ".... for which see 
the doc string for `org-log-into-drawer', or even better the way Achim's 
patch is worded.

Having just been picky, I must say that I am astounded by the general 
high standard of English both on this list and in the org documentation, 
from many people for whom it must be a second language. If only many of 
our native English writers could communicate so clearly and with correct 
grammar!

Ian.

  reply	other threads:[~2011-06-21  9:18 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-06-20 19:32 Achim Gratz
2011-06-21  7:49 ` Carsten Dominik
2011-06-21  9:18   ` Ian Barton [this message]
2011-06-26 15:27     ` Achim Gratz
2011-06-22 21:11   ` Achim Gratz
2011-06-26 16:10   ` [PATCH] Introduce CLOCK_INTO_DRAWER property like the existing LOG_INTO_DRAWER (was: [Bug] Doc string for org-clock-into-drawer truncated?) Achim Gratz
2011-06-27 10:14     ` [PATCH] Introduce CLOCK_INTO_DRAWER property like the existing LOG_INTO_DRAWER Bastien
2011-06-27 19:52       ` Achim Gratz
2011-06-28 16:38         ` Bastien

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4E0061E4.5070704@wilkesley.net \
    --to=lists@wilkesley.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=lists@manor-farm.org \
    --subject='Re: [Bug] Doc string for org-clock-into-drawer truncated?' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this 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).