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

[Rik]

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

I think the reason may have been consistency.  The first argument to @ref is
the name of the node to link to (equivalent to the link field in HTML), while
the third argument, if present, is the text to display instead of the node
name.

For a cross-reference to a function such as "ls" the node name is "XREFls",
but that looks bad when displayed as "See: XREFls" so the longer form


@ref(XREFls,,ls)


is used.  If the node name and the text are the same one isn't required to use
the longer form.  However, it may have made the regexp easier if the
references were always consistent.  See https://savannah.gnu.org/bugs/?56929
where I used regexp to make the appearance of links in plaintext look better.


    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?57845>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/