Re: [changeset] Re: [manual] In prepad, add reference to postpad.

[Daniel J Sebald]

Thorsten Meyer wrote:
> Hi,
>
> Francesco Potortì wrote:
>
> > # HG changeset patch
> > # User Francesco Potortì <address@hidden>
> > # Date 1230328478 -3600
> > # Node ID 6fa32fc22e5b1c9b84cbcc5ce7ab5d727b42adc5
> > # Parent  fcc46267f239ad0199b9fa26407c1d41efeae862
> > In prepad, add reference to postpad.
> >
> > diff -r fcc46267f239 -r 6fa32fc22e5b scripts/ChangeLog
> > --- a/scripts/ChangeLog Fri Dec 26 22:51:48 2008 +0100
> > +++ b/scripts/ChangeLog Fri Dec 26 22:54:38 2008 +0100
> > @@ -1,4 +1,6 @@ 2008-12-26  Francesco Potortì  <address@hidden
> > 2008-12-26  Francesco Potortì  <address@hidden>
> > +
> > +       * general/prepad.m: Add reference to postpad.
> >
> >         * general/postpad.m: Use @seealso.  Add reference to resize.
> >
> > diff -r fcc46267f239 -r 6fa32fc22e5b scripts/general/prepad.m
> > --- a/scripts/general/prepad.m  Fri Dec 26 22:51:48 2008 +0100
> > +++ b/scripts/general/prepad.m  Fri Dec 26 22:54:38 2008 +0100
> > @@ -33,6 +33,7 @@
> > ##
> > ## If the optional @var{dim} argument is given, then operate along this
> > ## dimension.
> > +## @seealso{postpad}
> > ## @end deftypefn
> >
> > ## Author: Tony Richardson <address@hidden>
> as it is, this patch breaks the documentation, because there is no anchor for 
> the postpad
> documentation (so the seealso reference to postpad points nowhere).
>
> Attached is a patch that adds an anchor for postpad.
>
> However, I am not sure if this should be applied: the actual documentation of 
> the postpad function
> is in the documentation string for prepad. So the seealso reference to postpad 
> would be a self
> reference.
>
> What do you think?

I deleted this email without paying much attention and then found the same 
problem.  'help -i' isn't working in the HG head.

Attached is a patch of how I managed to get a working 'doc'.  Besides the 
DOCSTRING line, I also found some @ref's that should be @xref's.  I don't think 
TeX understands things like @ref{Plot Styles}.

There are more errors with TeX overrun that I can't seem to find, but they 
don't cause fatal errors.

Someone familiar with the doc system or whomever checked in the dodgy lines 
please have a look.  Remove all the TeX errors if possible.  (They're hard to 
see in all that text output.)

Generally speaking, try to not check in things that don't compile or build 
properly.  Even when there may be some bug in the code, much of it is 
functional so long as it builds.

Dan

diff -Pur octave/doc/interpreter/matrix.txi 
octave-mod/doc/interpreter/matrix.txi
--- octave/doc/interpreter/matrix.txi   2009-01-04 02:09:16.000000000 -0600
+++ octave-mod/doc/interpreter/matrix.txi       2009-01-04 02:45:06.694434062 
-0600
@@ -154,6 +154,8 @@
 
 @DOCSTRING(prepad)
 
address@hidden(postpad)
+
 @DOCSTRING(blkdiag)
 
 @node Applying a Function to an Array
diff -Pur octave/doc/interpreter/plot.txi octave-mod/doc/interpreter/plot.txi
--- octave/doc/interpreter/plot.txi     2009-01-04 02:13:38.000000000 -0600
+++ octave-mod/doc/interpreter/plot.txi 2009-01-04 02:47:21.397231516 -0600
@@ -33,7 +33,7 @@
 Octave makes it easy to create many different types of two- and
 three-dimensional plots using a few high-level functions.
 
-If you need finer control over graphics, see @ref{Advanced Plotting}.
+If you need finer control over graphics, see @xref{Advanced Plotting}.
 
 @menu
 * Two-Dimensional Plots::       
@@ -337,7 +337,7 @@
 
 @DOCSTRING(text)
 
-See @ref{Text Properties} for the properties that you can set.
+See @xref{Text Properties} for the properties that you can set.
 
 @anchor{doc-ylabel}
 @anchor{doc-zlabel}