Mercurial > octave

changeset 27567:51c2e46e9a36

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Tweaks to @ref, @xref, @pxref invocations for better output. * open.m: Don't use spaces for empty arguments to @xref. Add @code{} around function name hgload. * camorbit.m, camup.m: Use @ref rather than @pxref to avoid generating 'see '. * movmad.m, movmax.m, movmean.m, movmedian.m, movmin.m, movprod.m, movstd.m, movsum.m, movvar.m: Use @pxref rather than @xref to generate lowercase 'see'.
author Rik <rik@octave.org>
date Sat, 26 Oct 2019 05:56:52 -0700
parents b86adf277734
children e78b6e7f743c
files scripts/miscellaneous/open.m scripts/plot/appearance/camorbit.m scripts/plot/appearance/camup.m scripts/statistics/movmad.m scripts/statistics/movmax.m scripts/statistics/movmean.m scripts/statistics/movmedian.m scripts/statistics/movmin.m scripts/statistics/movprod.m scripts/statistics/movstd.m scripts/statistics/movsum.m scripts/statistics/movvar.m
diffstat 12 files changed, 13 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/miscellaneous/open.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/miscellaneous/open.m	Sat Oct 26 05:56:52 2019 -0700
@@ -33,10 +33,10 @@
 ## Open the data file with @code{load}.  If no return value @var{output}
 ## is requested, variables are loaded in the base workspace.  Otherwise
 ## @var{output} will be a structure containing loaded data.
-## @xref{XREFload, , load function}.
+## @xref{XREFload,,load function}.
 ##
 ## @item .ofig
-## Open the figure with hgload.  @xref{XREFhgload, , hgload function}.
+## Open the figure with @code{hgload}.  @xref{XREFhgload,,hgload function}.
 ##
 ## @item .fig, .ofig
 ## Load the figure
--- a/scripts/plot/appearance/camorbit.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/plot/appearance/camorbit.m	Sat Oct 26 05:56:52 2019 -0700
@@ -88,7 +88,7 @@
 ## (Note: the rotation by @var{phi} is unaffected by @qcode{"camera"}.)
 ##
 ## The @code{camorbit} command modifies two camera properties:
-## @pxref{XREFcampos,,campos} and @pxref{XREFcamup,,camup}.
+## @ref{XREFcampos,,campos} and @ref{XREFcamup,,camup}.
 ##
 ## By default, this command affects the current axis; alternatively, an axis
 ## can be specified by the optional argument @var{hax}.
--- a/scripts/plot/appearance/camup.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/plot/appearance/camup.m	Sat Oct 26 05:56:52 2019 -0700
@@ -64,7 +64,7 @@
 ## A consequence is that ``pulling back'' on the up vector does not pitch the
 ## camera view (as that would require changing the target).  Setting the up
 ## vector is thus typically used only to roll the camera.  A more intuitive
-## command for this purpose is @pxref{XREFcamroll,,camroll}.
+## command for this purpose is @ref{XREFcamroll,,camroll}.
 ##
 ## Finally, we can reset the up vector to automatic mode:
 ##
--- a/scripts/statistics/movmad.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/statistics/movmad.m	Sat Oct 26 05:56:52 2019 -0700
@@ -116,7 +116,7 @@
 ## @end table
 ##
 ## Programming Note: This function is a wrapper which calls @code{movfun}.
-## For additional options and documentation, @xref{XREFmovfun,,movfun}.
+## For additional options and documentation, @pxref{XREFmovfun,,movfun}.
 ##
 ## @seealso{movfun, movslice, movmax, movmean, movmedian, movmin, movprod, movstd, movsum, movvar}
 ## @end deftypefn
--- a/scripts/statistics/movmax.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/statistics/movmax.m	Sat Oct 26 05:56:52 2019 -0700
@@ -116,7 +116,7 @@
 ## @end table
 ##
 ## Programming Note: This function is a wrapper which calls @code{movfun}.
-## For additional options and documentation, @xref{XREFmovfun,,movfun}.
+## For additional options and documentation, @pxref{XREFmovfun,,movfun}.
 ##
 ## @seealso{movfun, movslice, movmad, movmean, movmedian, movmin, movprod, movstd, movsum, movvar}
 ## @end deftypefn
--- a/scripts/statistics/movmean.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/statistics/movmean.m	Sat Oct 26 05:56:52 2019 -0700
@@ -116,7 +116,7 @@
 ## @end table
 ##
 ## Programming Note: This function is a wrapper which calls @code{movfun}.
-## For additional options and documentation, @xref{XREFmovfun,,movfun}.
+## For additional options and documentation, @pxref{XREFmovfun,,movfun}.
 ##
 ## @seealso{movfun, movslice, movmad, movmax, movmedian, movmin, movprod, movstd, movsum, movvar}
 ## @end deftypefn
--- a/scripts/statistics/movmedian.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/statistics/movmedian.m	Sat Oct 26 05:56:52 2019 -0700
@@ -116,7 +116,7 @@
 ## @end table
 ##
 ## Programming Note: This function is a wrapper which calls @code{movfun}.
-## For additional options and documentation, @xref{XREFmovfun,,movfun}.
+## For additional options and documentation, @pxref{XREFmovfun,,movfun}.
 ##
 ## @seealso{movfun, movslice, movmad, movmax, movmean, movmin, movprod, movstd, movsum, movvar}
 ## @end deftypefn
--- a/scripts/statistics/movmin.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/statistics/movmin.m	Sat Oct 26 05:56:52 2019 -0700
@@ -116,7 +116,7 @@
 ## @end table
 ##
 ## Programming Note: This function is a wrapper which calls @code{movfun}.
-## For additional options and documentation, @xref{XREFmovfun,,movfun}.
+## For additional options and documentation, @pxref{XREFmovfun,,movfun}.
 ##
 ## @seealso{movfun, movslice, movmad, movmax, movmean, movmedian, movprod, movstd, movsum, movvar}
 ## @end deftypefn
--- a/scripts/statistics/movprod.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/statistics/movprod.m	Sat Oct 26 05:56:52 2019 -0700
@@ -116,7 +116,7 @@
 ## @end table
 ##
 ## Programming Note: This function is a wrapper which calls @code{movfun}.
-## For additional options and documentation, @xref{XREFmovfun,,movfun}.
+## For additional options and documentation, @pxref{XREFmovfun,,movfun}.
 ##
 ## @seealso{movfun, movslice, movmad, movmax, movmean, movmedian, movmin, movstd, movsum, movvar}
 ## @end deftypefn
--- a/scripts/statistics/movstd.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/statistics/movstd.m	Sat Oct 26 05:56:52 2019 -0700
@@ -131,7 +131,7 @@
 ## @end table
 ##
 ## Programming Note: This function is a wrapper which calls @code{movfun}.
-## For additional options and documentation, @xref{XREFmovfun,,movfun}.
+## For additional options and documentation, @pxref{XREFmovfun,,movfun}.
 ##
 ## @seealso{movfun, movslice, movmad, movmax, movmean, movmedian, movmin, movprod, movsum, movvar}
 ## @end deftypefn
--- a/scripts/statistics/movsum.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/statistics/movsum.m	Sat Oct 26 05:56:52 2019 -0700
@@ -116,7 +116,7 @@
 ## @end table
 ##
 ## Programming Note: This function is a wrapper which calls @code{movfun}.
-## For additional options and documentation, @xref{XREFmovfun,,movfun}.
+## For additional options and documentation, @pxref{XREFmovfun,,movfun}.
 ##
 ## @seealso{movfun, movslice, movmad, movmax, movmean, movmedian, movmin, movprod, movstd, movvar}
 ## @end deftypefn
--- a/scripts/statistics/movvar.m	Sat Oct 26 05:31:40 2019 -0700
+++ b/scripts/statistics/movvar.m	Sat Oct 26 05:56:52 2019 -0700
@@ -130,7 +130,7 @@
 ## @end table
 ##
 ## Programming Note: This function is a wrapper which calls @code{movfun}.
-## For additional options and documentation, @xref{XREFmovfun,,movfun}.
+## For additional options and documentation, @pxref{XREFmovfun,,movfun}.
 ##
 ## @seealso{movfun, movslice, movmad, movmax, movmean, movmedian, movmin, movprod, movstd, movsum}
 ## @end deftypefn