Re: variable names in manual

[Carsten Dominik <carsten.dominik@gmail.com>]

On 26 apr. 2013, at 10:41, Suvayu Ali <fatkasuvayu+linux@gmail.com> wrote:

> 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
>>  @@@var{row}$@var{column}
>>  @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 <bzg@altern.org>
>  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.}}}}

Yes, I agree.  Let's wait for Bastien to take a last look at this, but it should indeed be reverted.

- Carsten

> 
> Cheers,
> 
> -- 
> Suvayu
> 
> Open source is the future. It sets us free.