bug-texinfo
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

`@pxref`: contradicting statements in manual


From: Werner LEMBERG
Subject: `@pxref`: contradicting statements in manual
Date: Thu, 06 Jan 2022 08:17:45 +0000 (UTC)


The documentation
https://www.gnu.org/software/texinfo/manual/texinfo/html_node/_0040pxref.html
says:

  The effect of `@pxref{node-name}` is similar to that of `see
  @ref{node-name}`.  However, in many circumstance the latter is
  preferrable, as this makes it clear in the Info output that the word
  “see” should be present.

This implies a recommendation against using `@pxref`, preferring `see
@ref`.  However, in
https://www.gnu.org/software/texinfo/manual/texinfo/html_node/_0040ref.html
you can find the following:

  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.

IMHO, the first quote should be improved, probably referring to the
second quote if good formatting for the Info format is desired.


    Werner

reply via email to

[Prev in Thread] Current Thread [Next in Thread]