Mercurial > hg > octave-max

diff scripts/sparse/pcr.m @ 14327:4d917a6a858b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use Octave coding conventions in @example blocks of docstrings. * accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m, celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m, contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m, dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m, ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m, flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m, idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m, isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m, logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m, moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m, polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m, randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m, shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m, strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m, subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m, voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in @example blocks of docstrings.
author Rik <octave@nomad.inbox5.com>
date Sat, 04 Feb 2012 22:12:50 -0800
parents 72c96de7a403
children ce2b59a6d0e5
line wrap: on
line diff
--- a/scripts/sparse/pcr.m
+++ b/scripts/sparse/pcr.m
@@ -101,16 +101,16 @@
 ##
 ## @example
 ## @group
-##      n = 10;
-##      A = sparse (diag (1:n));
-##      b = rand (N, 1);
+## n = 10;
+## A = sparse (diag (1:n));
+## b = rand (N, 1);
 ## @end group
 ## @end example
 ##
 ## @sc{Example 1:} Simplest use of @code{pcr}
 ##
 ## @example
-##   x = pcr(A, b)
+## x = pcr (A, b)
 ## @end example
 ##
 ## @sc{Example 2:} @code{pcr} with a function which computes
@@ -118,11 +118,11 @@
 ##
 ## @example
 ## @group
-##   function y = apply_a (x)
-##     y = [1:10]'.*x;
-##   endfunction
+## function y = apply_a (x)
+##   y = [1:10]' .* x;
+## endfunction
 ##
-##   x = pcr ("apply_a", b)
+## x = pcr ("apply_a", b)
 ## @end group
 ## @end example
 ##
@@ -132,15 +132,15 @@
 ##
 ## @example
 ## @group
-##   function y = apply_m (x)
-##     k = floor (length(x)-2);
-##     y = x;
-##     y(1:k) = x(1:k)./[1:k]';
-##   endfunction
+## function y = apply_m (x)
+##   k = floor (length (x) - 2);
+##   y = x;
+##   y(1:k) = x(1:k) ./ [1:k]';
+## endfunction
 ##
-##   [x, flag, relres, iter, resvec] = ...
-##                      pcr (A, b, [], [], "apply_m")
-##   semilogy([1:iter+1], resvec);
+## [x, flag, relres, iter, resvec] = ...
+##                    pcr (A, b, [], [], "apply_m")
+## semilogy ([1:iter+1], resvec);
 ## @end group
 ## @end example
 ##
@@ -149,13 +149,14 @@
 ##
 ## @example
 ## @group
-##   function y = apply_m (x, varargin)
-##     k = varargin@{1@};
-##     y = x; y(1:k) = x(1:k)./[1:k]';
-##   endfunction
+## function y = apply_m (x, varargin)
+##   k = varargin@{1@};
+##   y = x;
+##   y(1:k) = x(1:k) ./ [1:k]';
+## endfunction
 ##
-##   [x, flag, relres, iter, resvec] = ...
-##                      pcr (A, b, [], [], "apply_m"', [], 3)
+## [x, flag, relres, iter, resvec] = ...
+##                    pcr (A, b, [], [], "apply_m"', [], 3)
 ## @end group
 ## @end example
 ##