emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [O] variable names in manual


From: Suvayu Ali
Subject: Re: [O] variable names in manual
Date: Fri, 26 Apr 2013 10:41:03 +0200
User-agent: Mutt/1.5.21 (2012-12-30)

Hi Carsten,

On Fri, Apr 26, 2013 at 10:10:32AM +0200, Carsten Dominik wrote:
> 
> I suspect that the cases you are talking about here are due
> to incorrect use of the texinfo command @var{}.  This should
> only be used for metasyntactical variables, when they stand
> for something else in a description. 
> 
> Here is an example from the current manual.
> 
>   You can customize this behavior using the option
>   @var{org-table-use-standard-references}.} to use another, more general
>   representation that looks like this:
>   @example
>   @@@address@hidden
>   @end example
> 
> The first use of @var is incorrect, @code should be used here.  But
> the use in @var{row} and @var{column} is correct.
> 
> I believe that a while ago we did use @var and @code correctly, but
> someone went through and changed the @code{org-...} to @var{org-...}
> at some point.  We need to change this back.

I believe reverting this commit should do it:

  commit 7ed97e767dd4f4fbceac39a9758dbf594a4fd2fd
  Author: Bastien Guerry <address@hidden>
  Date:   Mon Apr 15 00:51:20 2013 +0200
  
      org.texi: Use @var{...} instead of @code{...} for variables
      
      * org.texi: Use @var{...} instead of @code{...} for variables.}}}}

Cheers,

-- 
Suvayu

Open source is the future. It sets us free.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]