Mercurial > hg > octave-lyh
diff doc/interpreter/expr.txi @ 14171:2ced2f59f523 stable
doc: miscellaneous documentation improvements
* aspell-octave.en.pws: Add new words to spelling dictionary.
* expr.txi: Use hyphens in "element-by-element" construction.
* install.txi: Miscellaneous docstring improvements.
* mk_undocumented_list: Update script.
* xlim.m: Add ylim and zlim to function index.
* data.cc: Add inf and nan to to function index.
* file-io.cc: Add octave_tmp_file_name to function index.
Expand docstring for SEEK_CUR and SEEK_END.
* help.cc: Miscellaneous docstring improvements.
* syscalls.cc: Improve docstrings for F_XXXX series of functions.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 08 Jan 2012 13:39:44 -0800 |
parents | c0ca47ab7641 |
children | c3fd61c59e9c |
line wrap: on
line diff
--- a/doc/interpreter/expr.txi +++ b/doc/interpreter/expr.txi @@ -523,7 +523,7 @@ @item @var{x} .+ @var{y} @opindex .+ -Element by element addition. This operator is equivalent to @code{+}. +Element-by-element addition. This operator is equivalent to @code{+}. @item @var{x} - @var{y} @opindex - @@ -532,17 +532,17 @@ shape. @item @var{x} .- @var{y} -Element by element subtraction. This operator is equivalent to @code{-}. +Element-by-element subtraction. This operator is equivalent to @code{-}. @item @var{x} * @var{y} @opindex * -Matrix multiplication. The number of columns of @var{x} must agree with +Matrix multiplication. The number of columns of @var{x} must agree with the number of rows of @var{y}, or they must be broadcastable to the same shape. @item @var{x} .* @var{y} @opindex .* -Element by element multiplication. If both operands are matrices, the +Element-by-element multiplication. If both operands are matrices, the number of rows and columns must both agree, or they must be broadcastable to the same shape. @@ -562,7 +562,7 @@ @item @var{x} ./ @var{y} @opindex ./ -Element by element right division. +Element-by-element right division. @item @var{x} \ @var{y} @opindex \ @@ -580,7 +580,7 @@ @item @var{x} .\ @var{y} @opindex .\ -Element by element left division. Each element of @var{y} is divided +Element-by-element left division. Each element of @var{y} is divided by each corresponding element of @var{x}. @item @var{x} ^ @var{y} @@ -601,12 +601,12 @@ @itemx @var{x} .** @var{y} @opindex .** @opindex .^ -Element by element power operator. If both operands are matrices, the +Element-by-element power operator. If both operands are matrices, the number of rows and columns must both agree, or they must be -broadcastable to the same shape. If several complex results are -possible, the one with smallest nonnegative argument (angle) is taken. -This may mean a complex root even if a real root is also possible. Use -@code{realpow}, @code{realsqrt}, @code{cbrt}, or @code{nthroot} if a +broadcastable to the same shape. If several complex results are +possible, the one with smallest non-negative argument (angle) is taken. +This rule may return a complex root even when a real root is also possible. +Use @code{realpow}, @code{realsqrt}, @code{cbrt}, or @code{nthroot} if a real result is preferred. @item -@var{x} @@ -632,7 +632,7 @@ Transpose. @end table -Note that because Octave's element by element operators begin with a +Note that because Octave's element-by-element operators begin with a @samp{.}, there is a possible ambiguity for statements like @example