[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
@pxref documentation
From: |
Stepan Kasal |
Subject: |
@pxref documentation |
Date: |
Tue, 21 Dec 2004 10:38:17 +0100 |
User-agent: |
Mutt/1.4.1i |
Hello Karl,
the automake manual contains some changes about *ref commands.
In particular, it contains @pxref's which are part of a sentence.
(The whole sentence is in a pair of parentheses, but I don't think
it's relevant here.) Run "grep -E '(^| )@px' automake.texi" to see it.
My first reaction was to report it as a bug in automake manual.
But then I decided to discuss it with you, since Alexandre credits you
in the ChangeLog entry.
To be frank, @pxref indeed looks nicer here. The info output looks like:
(However the package's maintainers can tune the default, *note The
`AC_PROG_LIBTOOL' macro: (libtool)AC_PROG_LIBTOOL.)
while with ``see @ref{...}'' it would look like
(However the package's maintainers can tune the default, see *Note The
`AC_PROG_LIBTOOL' macro: (libtool)AC_PROG_LIBTOOL.)
Please notice the ``note'' with a lowercase `n'.
Perhaps the texinfo manual shouldn't be so strict that @pxref cannot be
used in sentences? Do you want to you adjust the documentation?
But if we decide that these instances of @pxref are correct, I see no reason
why we couldn't take some of the places pointed out by
grep -E '(^|see )@ref' automake.texi
and use @pxref there, too.
What do you think about it?
Have a nice day,
Stepan
- @pxref documentation,
Stepan Kasal <=