emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Rasmus <rasmus@gmx.us>
To: emacs-orgmode@gnu.org
Subject: Comments in @example in org.texi
Date: Tue, 13 Jan 2015 13:02:14 +0100	[thread overview]
Message-ID: <87ppaikhx5.fsf@gmx.us> (raw)

Hi,

In org.texi, sometimes examples have comments with (·) and sometimes with
@r{·}.  E.g.

   @example
   #+TOC: headlines 1 local  (insert local TOC, with direct children only)
   @end example

And

   @example
   #+INCLUDE: "~/.emacs" :lines "5-10"   @r{Include lines 5 to 10, 10 excluded}
   @end example

Is there any logic behind when @r{·} and when (·) is used?  Or should we
try to make it more coherent?

Thanks,
Rasmus

-- 
This is the kind of tedious nonsense up with which I will not put

next             reply	other threads:[~2015-01-13 12:02 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-13 12:02 Rasmus [this message]
2015-01-13 14:32 ` Comments in @example in org.texi Nicolas Goaziou
2015-01-13 16:25   ` Rasmus
2015-01-13 18:50     ` 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

  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=87ppaikhx5.fsf@gmx.us \
    --to=rasmus@gmx.us \
    --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

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).