Mercurial > hg > octave-shane
changeset 12520:ad05e1547398
Add function chop to documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Fri, 18 Mar 2011 18:51:45 -0700 |
parents | 91ccd08fe80c |
children | 02e48856e486 |
files | doc/ChangeLog doc/interpreter/arith.txi doc/interpreter/linalg.txi scripts/ChangeLog scripts/general/curl.m scripts/general/divergence.m scripts/linear-algebra/cross.m src/ChangeLog src/DLD-FUNCTIONS/dot.cc |
diffstat | 9 files changed, 48 insertions(+), 31 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2010-03-18 Rik <octave@nomad.inbox5.com> + + * interpreter/arith.txi, interpreter/linalg.txi: Add function chop + to documentation. Re-order Utility Functions and move function dot + from linear algebra section to be with other utility functions. + 2010-03-18 Rik <octave@nomad.inbox5.com> * interpreter/basics.txi: Add gen_doc_cache, get_help_text,
--- a/doc/interpreter/arith.txi +++ b/doc/interpreter/arith.txi @@ -198,31 +198,13 @@ @DOCSTRING(ceil) -@DOCSTRING(curl) - -@DOCSTRING(cross) - -@DOCSTRING(del2) - -@DOCSTRING(divergence) - -@DOCSTRING(factor) - -@DOCSTRING(factorial) - @DOCSTRING(fix) @DOCSTRING(floor) -@DOCSTRING(gcd) - -@DOCSTRING(gradient) +@DOCSTRING(round) -@DOCSTRING(hypot) - -@DOCSTRING(lcm) - -@DOCSTRING(list_primes) +@DOCSTRING(roundb) @DOCSTRING(max) @@ -232,15 +214,37 @@ @DOCSTRING(cummin) +@DOCSTRING(hypot) + +@DOCSTRING(gradient) + +@DOCSTRING(dot) + +@DOCSTRING(cross) + +@DOCSTRING(divergence) + +@DOCSTRING(curl) + +@DOCSTRING(del2) + +@DOCSTRING(factorial) + +@DOCSTRING(factor) + +@DOCSTRING(gcd) + +@DOCSTRING(lcm) + +@DOCSTRING(chop) + +@DOCSTRING(rem) + @DOCSTRING(mod) @DOCSTRING(primes) -@DOCSTRING(rem) - -@DOCSTRING(round) - -@DOCSTRING(roundb) +@DOCSTRING(list_primes) @DOCSTRING(sign)
--- a/doc/interpreter/linalg.txi +++ b/doc/interpreter/linalg.txi @@ -88,8 +88,6 @@ @DOCSTRING(det) -@DOCSTRING(dot) - @DOCSTRING(eig) @DOCSTRING(givens)
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,8 @@ +2010-03-18 Rik <octave@nomad.inbox5.com> + + * general/curl.m, general/divergence.m, linear-algebra/cross.m: + Update seealso cross references. + 2010-03-18 Rik <octave@nomad.inbox5.com> * help/get_first_help_sentence.m: Improve docstring. Add tests.
--- a/scripts/general/curl.m +++ b/scripts/general/curl.m @@ -44,7 +44,7 @@ ## for two-dimensional input. For three-dimensional input the scalar ## rotation is calculated at each grid point in direction of the vector field ## at that point. -## @seealso{divergence, gradient, del2, cross, dot} +## @seealso{divergence, gradient, del2, cross} ## @end deftypefn ## Author: Kai Habel <kai.habel@gmx.de>
--- a/scripts/general/divergence.m +++ b/scripts/general/divergence.m @@ -42,7 +42,7 @@ ## The coordinates of the vector field can be given by the arguments @var{x}, ## @var{y}, @var{z} or @var{x}, @var{y} respectively. ## -## @seealso{curl, gradient, del2, cross, dot} +## @seealso{curl, gradient, del2, dot} ## @end deftypefn ## Author: Kai Habel <kai.habel@gmx.de>
--- a/scripts/linear-algebra/cross.m +++ b/scripts/linear-algebra/cross.m @@ -33,7 +33,7 @@ ## along the first dimension with 3 elements. The optional argument ## @var{dim} forces the cross product to be calculated along ## the specified dimension. -## @seealso{dot} +## @seealso{dot, curl} ## @end deftypefn ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,7 @@ +2010-03-18 Rik <octave@nomad.inbox5.com> + + * dot.cc: Improve seealso cross references in docstring. + 2010-03-18 Rik <octave@nomad.inbox5.com> * help.cc (get_help_text, get_help_text_from_file): Improve docstrings.
--- a/src/DLD-FUNCTIONS/dot.cc +++ b/src/DLD-FUNCTIONS/dot.cc @@ -116,7 +116,7 @@ but avoids forming a temporary array and is faster. When @var{X} and\n\ @var{Y} are column vectors, the result is equivalent to\n\ @code{@var{X}' * @var{Y}}.\n\ -@seealso{cross}\n\ +@seealso{cross, divergence}\n\ @end deftypefn") { octave_value retval;