emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nick Dokos <nicholas.dokos@hp.com>
To: =?utf-8?B?xaB0xJtww6FuIE7Em21lYw==?= <stepnem@gmail.com>
Cc: nicholas.dokos@hp.com, emacs-orgmode@gnu.org
Subject: Re: `org-refile' doc string
Date: Wed, 28 Apr 2010 14:56:44 -0400	[thread overview]
Message-ID: <10381.1272481004@alphaville.usa.hp.com> (raw)
In-Reply-To: Message from =?utf-8?B?xaB0xJtww6FuIE7Em21lYw==?= <stepnem@gmail.com> of "Wed\, 28 Apr 2010 20\:28\:33 +0200." <87sk6fh1ny.fsf@gmail.com>

Štěpán Němec <stepnem@gmail.com> wrote:

> 
> In the documentation of `org-refile' we read:
> 
>   If there is an active region, all entries in that region will be moved.
>   However, the region must fulfil the requirement that the first heading
>   is the first one sets the top-level of the moved text - at most siblings
>   below it are allowed.
> 
> 
> I completely fail at parsing the second sentence. Could please someone
> who knows what it's trying to say fix it?
> 

What's the problem? It's crystal clear! :-)

But seriously, I think what's it's trying to say is that you can't just
select an arbitrary region of the org file and refile it: it has to
satisfy some constraints. For example, if you start at a level 2 headline,
the region cannot then include a level 1 headline further down; it can only
include level 2 and lower headlines.

The error message from the function when you try something illegal is
much clearer than the long explanation above:

  "The region is not a (sequence of) subtree(s)"

Maybe the doc string should say:

  ... However, the region must satisfy some constraints: it has to be
  a subtree (or a sequence of subtrees).

Would that be clear enough?

Nick

  reply	other threads:[~2010-04-28 19:00 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-04-28 18:28 `org-refile' doc string Štěpán Němec
2010-04-28 18:56 ` Nick Dokos [this message]
2010-04-28 20:32   ` Štěpán Němec
2010-04-28 21:04     ` Nick Dokos
2010-04-28 21:45 ` [PATCH] Clean up docstring for org-refile Bernt Hansen

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=10381.1272481004@alphaville.usa.hp.com \
    --to=nicholas.dokos@hp.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=stepnem@gmail.com \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).