emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Carsten Dominik <carsten.dominik@gmail.com>
To: Suvayu Ali <fatkasuvayu+linux@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: variable names in manual
Date: Fri, 26 Apr 2013 10:46:58 +0200	[thread overview]
Message-ID: <0E4CF51C-C71C-435B-B382-8C85514C0113@gmail.com> (raw)
In-Reply-To: <20130426084103.GD2769@kuru.dyndns-at-home.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.

  reply	other threads:[~2013-04-26  8:47 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-25 23:37 variable names in manual Greg Minshall
2013-04-25 23:48 ` Suvayu Ali
2013-04-26  7:45   ` Carsten Dominik
2013-04-26  8:10   ` Carsten Dominik
2013-04-26  8:41     ` Suvayu Ali
2013-04-26  8:46       ` Carsten Dominik [this message]
2013-04-26  9:27         ` Bastien
2013-04-26  9:59           ` Suvayu Ali
2013-04-26 10:11             ` Carsten Dominik
2013-04-26 10:27               ` Suvayu Ali
2013-04-26 10:31                 ` Carsten Dominik
2013-04-26  6:56 ` Bastien
2013-04-26  7:21   ` Suvayu Ali
2013-04-26  7:50     ` Bastien
2013-04-26 11:03   ` Greg Minshall
2013-04-26 12:29     ` Bastien
2013-04-26 13:40       ` Greg Minshall
  -- strict thread matches above, loose matches on Subject: below --
2013-04-25 23:33 Greg Minshall

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=0E4CF51C-C71C-435B-B382-8C85514C0113@gmail.com \
    --to=carsten.dominik@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=fatkasuvayu+linux@gmail.com \
    /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 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).