all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Jorge <jorge13515@gmail.com>
To: org mode <emacs-orgmode@gnu.org>
Subject: Re: Bug: Several small documentation problems [8.3.6 (8.3.6-4-g4835be-elpaplus @ /home/jorge/.emacs.d/elpa/org-plus-contrib-20160926/)]
Date: Fri, 30 Sep 2016 10:36:37 -0300	[thread overview]
Message-ID: <CAJR3QnfSxKcRBNZMf8OyWBPLOM-7-kZNgDN7RffR2wuyO0A7Og@mail.gmail.com> (raw)
In-Reply-To: <87intexx22.fsf@nicolasgoaziou.fr>

On 29 September 2016 at 17:36, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> I think "grandparent" is correct. In the following document
>
>   * H1
>   ** H2
>   Text<--point
>
> "H2" is the parent headline of "Text" and as a consequence, "H1" is its
> grandparent.
What if point is in the headline, which is often the case?  Besides the
docstring is inconsistent:
      With two universal prefix arguments, insert the heading at the end
      of the grandparent subtree.  For example, if point is within a
      2nd-level heading, then it will insert a 2nd-level heading at the
      end of the 1st-level parent heading.

In the first sentence it says "grandparent subtree", whereas in the second
sentence it says "parent heading".  And the manual says "parent":
      Calling this command with `C-u C-u' will unconditionally respect
      the headline's content and create a new item at the end of the
      parent subtree.

Perhaps uniformity of terminology would help here.

> You are right, M-RET and C-RET are confusing, and making C-u M-RET
> a duplicate of C-RET is wasting some important keybinding. This was
> discussed on this ML already (with Rasmus) but led nowhere so far.
>
> In any case, it is more future-proof to not insist on the fact that
> C-RET is C-u M-RET.
I think that, whether we describe both behaviors separately or tell
the user that
C-RET is equivalent to C-u M-RET, the commitment (to not change the behavior)
is the same.  But if you still think that describing both separately is more
future-proof, I won't argue.

But I still ask you to look at the other points I made about that manual
section: that it doesn't adequately explain the effect of C-u M-RET, and that
the description of C-RET is actually wrong.

> Thank you for this tedious, yet very important work.
Thank you very much for working on Org!

-- 
• I am Brazilian.  I hope my English is correct and I welcome corrections.
• Please adopt free formats like PDF, ODF, Org, LaTeX, Opus, WebM and 7z.
• Free (as in free speech) software for Android: https://f-droid.org/

  reply	other threads:[~2016-09-30 13:36 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-29 18:36 Bug: Several small documentation problems [8.3.6 (8.3.6-4-g4835be-elpaplus @ /home/jorge/.emacs.d/elpa/org-plus-contrib-20160926/)] Jorge
2016-09-29 20:36 ` Nicolas Goaziou
2016-09-30 13:36   ` Jorge [this message]
2016-10-01 22:36     ` Nicolas Goaziou
2016-10-02 19:40       ` Jorge
2016-10-04 10:03         ` Nicolas Goaziou

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

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

  git send-email \
    --in-reply-to=CAJR3QnfSxKcRBNZMf8OyWBPLOM-7-kZNgDN7RffR2wuyO0A7Og@mail.gmail.com \
    --to=jorge13515@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.