Mercurial > hg > octave-avbm
changeset 16589:a3fdd6041e64
Fix ellipj, ellipke, and expint docstrings
* ellipj.cc, ellipke.m, expint.m: Fix docstring signatures and wording.
| author | Mike Miller <mtmiller@ieee.org> |
|---|---|
| date | Sun, 28 Apr 2013 19:25:50 -0400 |
| parents | f423873d3275 |
| children | 4d2b0104ee05 |
| files | libinterp/corefcn/ellipj.cc scripts/specfun/ellipke.m scripts/specfun/expint.m |
| diffstat | 3 files changed, 28 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/ellipj.cc +++ b/libinterp/corefcn/ellipj.cc @@ -136,9 +136,9 @@ DEFUN (ellipj, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{sn}, @var{cn}, @var{dn}] =} \ -ellipj (@var{u}, @var{m}, @var{err})\n\ -Compute the Jacobi elliptic functions sn, cn, dn of complex argument and real parameter.\n\ +@deftypefn {Built-in Function} {[@var{sn}, @var{cn}, @var{dn}, @var{err}] =} ellipj (@var{u}, @var{m})\n\ +Compute the Jacobi elliptic functions @var{sn}, @var{cn}, and @var{dn}\n\ +of complex argument @var{u} and real parameter @var{m}.\n\ \n\ If @var{m} is a scalar, the results are the same size as @var{u}.\n\ If @var{u} is a scalar, the results are the same size as @var{m}.\n\ @@ -163,6 +163,7 @@ Ref: Abramowitz, Milton and Stegun, Irene A\n\ Handbook of Mathematical Functions, Dover, 1965\n\ Chapter 16 (Sections 16.4, 16.13 and 16.15)\n\ +@seealso{ellipke}\n\ @end deftypefn") { octave_value_list retval;
--- a/scripts/specfun/ellipke.m +++ b/scripts/specfun/ellipke.m @@ -22,12 +22,13 @@ ## @deftypefn {Function File} {} ellipke (@var{m}) ## @deftypefnx {Function File} {} ellipke (@var{m}, @var{tol}) ## @deftypefnx {Function File} {[@var{k}, @var{e}] =} ellipke (@dots{}) -## Compute complete elliptic integral of first K(@var{m}) and second E(@var{m}). +## Compute complete elliptic integral of the first K(@var{m}) and second +## E(@var{m}) kind. ## -## @var{m} is either real array or scalar with 0 <= m <= 1 +## @var{m} is either real array or scalar with 0 <= m <= 1. ## -## @var{tol} will be ignored (@sc{Matlab} uses this to allow faster, less -## accurate approximation) +## @var{tol} is currently ignored (@sc{Matlab} uses this to allow faster, +## less accurate approximation). ## ## Ref: Abramowitz, Milton and Stegun, Irene A. Handbook of Mathematical ## Functions, Dover, 1965, Chapter 17.
--- a/scripts/specfun/expint.m +++ b/scripts/specfun/expint.m @@ -19,13 +19,24 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} expint (@var{x}) ## Compute the exponential integral, -## @verbatim -## infinity -## / -## expint(x) = | exp(t)/t dt -## / -## x -## @end verbatim +## @tex +## $$ +## E_1 (x) = \int_x^\infty {e^{-t} \over t} dt. +## $$ +## @end tex +## @ifnottex +## +## @example +## @group +## infinity +## / +## expint (x) = | exp (-t)/t dt +## / +## x +## @end group +## @end example +## +## @end ifnottex ## @end deftypefn function y = expint (x) @@ -44,7 +55,7 @@ ## @verbatim ## infinity ## / -## expint(x) = | exp(t)/t dt +## expint(x) = | exp(-t)/t dt ## / ## x ## @end verbatim