[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: `@pxref`: contradicting statements in manual
From: |
Eli Zaretskii |
Subject: |
Re: `@pxref`: contradicting statements in manual |
Date: |
Thu, 06 Jan 2022 11:09:24 +0200 |
> Date: Thu, 06 Jan 2022 08:17:45 +0000 (UTC)
> From: Werner LEMBERG <wl@gnu.org>
>
> The `@ref` command can tempt writers to express themselves in a
> manner that is suitable for a printed manual but looks awkward in
> the Info format. Bear in mind that your audience could be using
> both the printed and the Info format.
>
> This implies exactly the opposite.
No, it doesn't. It refers to a different issue: a tendency to use
@ref without "see" or anything like that, because people think about
HTML-style hyperlinks. Here's a relevant example:
@multitable @columnfractions .30 .20 .50
[...]
@item agent expression @tab length of @tab @ref{agent expression object}
Another one:
@table @code
[...]
@item -address [@code{on}|@code{off}]
Set printing of addresses.
Related setting: @ref{set print address}.
> IMHO, the first quote should be improved, probably referring to the
> second quote if good formatting for the Info format is desired.
They are unrelated. Perhaps the second one should be made more
explicit.
Re: `@pxref`: contradicting statements in manual,
Eli Zaretskii <=