Mercurial > hg > octave-nkf
changeset 12344:68ac95d2460c
Periodic grammarcheck of documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sat, 05 Feb 2011 12:58:34 -0800 |
parents | 38384a0f75c0 |
children | 8c0bf79b5c6a |
files | scripts/ChangeLog scripts/help/help.m scripts/linear-algebra/onenormest.m scripts/plot/graphics_toolkit.m scripts/plot/pie3.m scripts/plot/view.m scripts/signal/periodogram.m |
diffstat | 7 files changed, 15 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,8 @@ +2010-02-05 Rik <octave@nomad.inbox5.com> + + * help/help.m, linear-algebra/onenormest.m, plot/graphics_toolkit.m, + plot/pie3.m, plot/view.m, signal/periodogram.m: Grammarcheck docstrings. + 2011-02-05 Ben Abbott <bpabbott@mac.com> * plot/legend.m: Add demo for inline keys created by two plot commands.
--- a/scripts/help/help.m +++ b/scripts/help/help.m @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Command} {} help @var{name} +## @deftypefn {Command} {} help @var{name} ## @deftypefnx {Command} {} help @code{--list} ## Display the help text for @var{name}. For example, the command ## @kbd{help help} prints a short message describing the @code{help}
--- a/scripts/linear-algebra/onenormest.m +++ b/scripts/linear-algebra/onenormest.m @@ -25,8 +25,8 @@ ## only 5 test vectors are used. ## ## If the matrix is not explicit, e.g., when estimating the norm of -## @code{inv (@var{A})} given an LU@tie{}factorization, @code{onenormest} applies -## @var{A} and its conjugate transpose through a pair of functions +## @code{inv (@var{A})} given an LU@tie{}factorization, @code{onenormest} +## applies @var{A} and its conjugate transpose through a pair of functions ## @var{apply} and @var{apply_t}, respectively, to a dense matrix of size ## @var{n} by @var{t}. The implicit version requires an explicit dimension ## @var{n}.
--- a/scripts/plot/graphics_toolkit.m +++ b/scripts/plot/graphics_toolkit.m @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} graphics_toolkit (@var{name}) ## @deftypefnx {Function File} {} graphics_toolkit (@var{hlist}, @var{name}) -## Change the default graphics graphics toolkit to @var{name}. If the +## Change the default graphics toolkit to @var{name}. If the ## toolkit is not already loaded, it is first initialized by calling the ## function @code{__init_@var{name}__}. ##
--- a/scripts/plot/pie3.m +++ b/scripts/plot/pie3.m @@ -23,7 +23,7 @@ ## @deftypefnx {Function File} {} pie3 (@dots{}, @var{labels}) ## @deftypefnx {Function File} {} pie3 (@var{h}, @dots{}); ## @deftypefnx {Function File} {@var{h} =} pie3 (@dots{}); -## Draw a a 3-D pie chart. +## Draw a 3-D pie chart. ## ## Called with a single vector argument, produces a 3-D pie chart of the ## elements in @var{x}, with the size of the slice determined by percentage
--- a/scripts/plot/view.m +++ b/scripts/plot/view.m @@ -23,7 +23,7 @@ ## @deftypefnx {Function File} {} view ([@var{x}, @var{y}, @var{z}]) ## @deftypefnx {Function File} {} view (@var{dims}) ## @deftypefnx {Function File} {} view (@var{ax}, @dots{}) -## Query or set set the viewpoint for the current axes. The parameters +## Query or set the viewpoint for the current axes. The parameters ## @var{azimuth} and @var{elevation} can be given as two arguments or as ## 2-element vector. ## The viewpoint can also be given with Cartesian coordinates @var{x},
--- a/scripts/signal/periodogram.m +++ b/scripts/signal/periodogram.m @@ -34,7 +34,8 @@ ## ## @itemize ## @item x: data; if real-valued a one-sided spectrum is estimated, -## if complex-valued or range indicates "@nospell{twosided}", the full spectrum is estimated. +## if complex-valued or range indicates "@nospell{twosided}", the full +## spectrum is estimated. ## ## @item win: weight data with window, x.*win is used for further computation, ## if window is empty, a rectangular window is used. @@ -44,8 +45,8 @@ ## @item Fs: sampling rate, default 1. ## ## @item range: "@nospell{onesided}" computes spectrum from [0..nfft/2+1]. -## "@nospell{twosided}" computes spectrum from [0..nfft-1]. These strings can appear at any -## position in the list input arguments after window. +## "@nospell{twosided}" computes spectrum from [0..nfft-1]. These strings +## can appear at any position in the list input arguments after window. ## ## @item Pxx: one-, or two-sided power spectrum. ##