emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Comments in @example in org.texi
@ 2015-01-13 12:02 Rasmus
  2015-01-13 14:32 ` Nicolas Goaziou
  0 siblings, 1 reply; 4+ messages in thread
From: Rasmus @ 2015-01-13 12:02 UTC (permalink / raw)
  To: emacs-orgmode

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Comments in @example in org.texi
  2015-01-13 12:02 Comments in @example in org.texi Rasmus
@ 2015-01-13 14:32 ` Nicolas Goaziou
  2015-01-13 16:25   ` Rasmus
  0 siblings, 1 reply; 4+ messages in thread
From: Nicolas Goaziou @ 2015-01-13 14:32 UTC (permalink / raw)
  To: Rasmus; +Cc: emacs-orgmode

Hello,

Rasmus <rasmus@gmx.us> writes:

> 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?

I don't think so.

> Or should we try to make it more coherent?

IMO @r{.} should be used everywhere in these situations.


Regards,

-- 
Nicolas Goaziou

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Comments in @example in org.texi
  2015-01-13 14:32 ` Nicolas Goaziou
@ 2015-01-13 16:25   ` Rasmus
  2015-01-13 18:50     ` Nicolas Goaziou
  0 siblings, 1 reply; 4+ messages in thread
From: Rasmus @ 2015-01-13 16:25 UTC (permalink / raw)
  To: emacs-orgmode

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

>> Or should we try to make it more coherent?
>
> IMO @r{.} should be used everywhere in these situations.

I pushed a commit that removs the ()-comments I could find.

—Rasmus

-- 
m-mm-mmm-mmmm bacon!

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Comments in @example in org.texi
  2015-01-13 16:25   ` Rasmus
@ 2015-01-13 18:50     ` Nicolas Goaziou
  0 siblings, 0 replies; 4+ messages in thread
From: Nicolas Goaziou @ 2015-01-13 18:50 UTC (permalink / raw)
  To: Rasmus; +Cc: emacs-orgmode

Rasmus <rasmus@gmx.us> writes:

> I pushed a commit that removs the ()-comments I could find.

Thank you.

Regards,

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2015-01-13 18:49 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-01-13 12:02 Comments in @example in org.texi Rasmus
2015-01-13 14:32 ` Nicolas Goaziou
2015-01-13 16:25   ` Rasmus
2015-01-13 18:50     ` Nicolas Goaziou

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