From: Eli Zaretskii <eliz@gnu.org>
To: Wolfgang Jenkner <wjenkner@inode.at>
Cc: 13292@debbugs.gnu.org
Subject: bug#13292: 24.3.50; wrong sytax description in (elisp) Case Tables
Date: Sat, 29 Dec 2012 10:30:17 +0200 [thread overview]
Message-ID: <83txr5l0py.fsf@gnu.org> (raw)
In-Reply-To: <851ue9ofyk.fsf@iznogoud.viz>
> From: Wolfgang Jenkner <wjenkner@inode.at>
> Cc: eliz@gnu.org, drew.adams@oracle.com
> Date: Sat, 29 Dec 2012 01:21:05 +0100
>
> On Fri, Dec 28 2012, Eli Zaretskii wrote:
>
> >> From: "Drew Adams" <drew.adams@oracle.com>
> [...]
> >> In that case, there are bugs in the other direction, in other nodes of the
> >> manual - nodes that use uppercase for parameters.
> >>
> >> For example:
> >>
> >> `A Sample Function Description' - `count-loop'
> >> `Syntax Table Functions' - `with-syntax-table'
> >> `Using Lexical Binding' - `special-variable-p'
> >> `Syntax Table Internals' - `string-to-syntax'
> >> `Declare Form' - `declare'
> >>
> >> Note that `A Sample Function Description' is the very place where we explain the
> >> syntax convention and give an example of it. Not a good place to set a bad
> >> example.
> >
> > It's not bad. This is done on purpose, see the Texinfo sources, which
> > use @var in this case.
>
> But other "imaginary" example definitions in intro.texi don't use @var.
> Nor does any "real" @defspec in doc/lispref use that.
The Texinfo manual is ambiguous wrt this issue. It allows using @var
in some cases. The result in print is a slightly different typeface;
in contrast, the result in the Info output is VERY different.
However, since the references to the arguments in the text _always_
use @var, so are rendered in CAPS in Info, I consider this bug report
a rather petty and even an overly-pedantic one.
> Also, in contrast to the makeinfo program, texinfo-format-region would
> produce
>
> -- Special form: count-loop (VAR [FROM TO [INC]]) BODY...
>
> in both cases, with or without @var. Perhaps, that's the reason that
> nobody noticed at the time?
I doubt that, as no one uses texinfo-format-region anymore, since it
doesn't support so many Texinfo features introduced in recent years.
> So is there anything wrong with Drew's revised suggestion (as
> I understand it)?
See above. That said, I don't want to argue anymore, so I installed
your changes on the emacs-24 branch; thanks.
next prev parent reply other threads:[~2012-12-29 8:30 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-12-28 15:26 bug#13292: 24.3.50; wrong sytax description in (elisp) Case Tables Drew Adams
2012-12-28 15:30 ` Drew Adams
2012-12-28 16:39 ` Eli Zaretskii
2012-12-28 16:57 ` Drew Adams
2012-12-28 18:30 ` Eli Zaretskii
2012-12-28 18:46 ` Drew Adams
2012-12-29 0:21 ` Wolfgang Jenkner
2012-12-29 8:30 ` Eli Zaretskii [this message]
2012-12-29 15:48 ` Wolfgang Jenkner
2012-12-29 16:17 ` Drew Adams
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.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83txr5l0py.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=13292@debbugs.gnu.org \
--cc=wjenkner@inode.at \
/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.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).