[Top][All Lists]

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

[Octave-bug-tracker] [bug #57845] doc: remove redundant @ref, @xref, and

From: Mike Miller
Subject: [Octave-bug-tracker] [bug #57845] doc: remove redundant @ref, @xref, and @pxref arguments
Date: Tue, 18 Feb 2020 02:15:56 -0500 (EST)
User-agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.87 Safari/537.36

Follow-up Comment #3, bug #57845 (project octave):

I think we should drop those third arguments when the label is the same as the
name of the reference to link to, because it does make the output look better
in the Info manual.

Compare this one-argument @ref link from the docstring for 'max'

For two inputs (X and Y), return the pairwise maximum according to
the rules for *note Broadcasting::.

with this three-argument @ref link from the docstring for 'text'

Programming Notes: The full list of properties is documented at
*note Text Properties: Text Properties.

The first is much clearer, the second demonstrates the redundancy that Nick
mentions in this bug report, only present because of using the three-argument
@ref syntax.

Both of these look fine in the plain text output that is post-processed by the
'__makeinfo__' function, I'm quoting from the Info format of the user manual.


Reply to this item at:


  Message sent via Savannah

reply via email to

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