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:10:32 +0200 [thread overview]
Message-ID: <FC50E84E-6D2C-42BF-96E0-983DF00841EE@gmail.com> (raw)
In-Reply-To: <20130425234809.GC12340@kuru.dyndns-at-home.com>
On 26 apr. 2013, at 01:48, Suvayu Ali <fatkasuvayu+linux@gmail.com> wrote:
> On Thu, Apr 25, 2013 at 07:37:25PM -0400, Greg Minshall wrote:
>> sorry about that. i was going to ask about the variable names in the
>> current (8.x) documentation being in upper case. (then, wanted to check
>
> [...chomp...chomp...chomp...]
>
>> but, it means that placing the cursor over the name and hitting C-h v
>> doesn't default to that name. (and, i've always found that a convenient
>> way to navigate.)
>>
>> so, just curious is it might make sense to revert to lower case names.
>
> I wasn't aware of this change! I would agree with Greg here.
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.
- Carsten
>
> --
> Suvayu
>
> Open source is the future. It sets us free.
>
next prev parent reply other threads:[~2013-04-26 8:10 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 [this message]
2013-04-26 8:41 ` Suvayu Ali
2013-04-26 8:46 ` Carsten Dominik
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=FC50E84E-6D2C-42BF-96E0-983DF00841EE@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).