Mercurial > octave

changeset 30560:9ed1cf9e446e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Document output for all functions in elfun/ directory (bug #61681) * acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m, asec.m, asecd.m, asech.m, asind.m, atan2d.m, atand.m, cosd.m, cot.m, cotd.m, coth.m, csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m: Document output for all functions in elfun/ directory (bug #61681)
author Rik <rik@octave.org>
date Mon, 27 Dec 2021 20:04:52 -0800
parents 841a10208c38
children 1c6e04afe50d
files scripts/elfun/acosd.m scripts/elfun/acot.m scripts/elfun/acotd.m scripts/elfun/acoth.m scripts/elfun/acsc.m scripts/elfun/acscd.m scripts/elfun/acsch.m scripts/elfun/asec.m scripts/elfun/asecd.m scripts/elfun/asech.m scripts/elfun/asind.m scripts/elfun/atan2d.m scripts/elfun/atand.m scripts/elfun/cosd.m scripts/elfun/cot.m scripts/elfun/cotd.m scripts/elfun/coth.m scripts/elfun/csc.m scripts/elfun/cscd.m scripts/elfun/csch.m scripts/elfun/sec.m scripts/elfun/secd.m scripts/elfun/sech.m scripts/elfun/sind.m scripts/elfun/tand.m
diffstat 25 files changed, 27 insertions(+), 27 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/elfun/acosd.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/acosd.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} acosd (@var{x})
+## @deftypefn {} {@var{y} =} acosd (@var{x})
 ## Compute the inverse cosine in degrees for each element of @var{x}.
 ## @seealso{cosd, acos}
 ## @end deftypefn
--- a/scripts/elfun/acot.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/acot.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} acot (@var{x})
+## @deftypefn {} {@var{y} =} acot (@var{x})
 ## Compute the inverse cotangent in radians for each element of @var{x}.
 ## @seealso{cot, acotd}
 ## @end deftypefn
--- a/scripts/elfun/acotd.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/acotd.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} acotd (@var{x})
+## @deftypefn {} {@var{y} =} acotd (@var{x})
 ## Compute the inverse cotangent in degrees for each element of @var{x}.
 ## @seealso{cotd, acot}
 ## @end deftypefn
--- a/scripts/elfun/acoth.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/acoth.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} acoth (@var{x})
+## @deftypefn {} {@var{y} =} acoth (@var{x})
 ## Compute the inverse hyperbolic cotangent of each element of @var{x}.
 ## @seealso{coth}
 ## @end deftypefn
--- a/scripts/elfun/acsc.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/acsc.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} acsc (@var{x})
+## @deftypefn {} {@var{y} =} acsc (@var{x})
 ## Compute the inverse cosecant in radians for each element of @var{x}.
 ## @seealso{csc, acscd}
 ## @end deftypefn
--- a/scripts/elfun/acscd.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/acscd.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} acscd (@var{x})
+## @deftypefn {} {@var{y} =} acscd (@var{x})
 ## Compute the inverse cosecant in degrees for each element of @var{x}.
 ## @seealso{cscd, acsc}
 ## @end deftypefn
--- a/scripts/elfun/acsch.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/acsch.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} acsch (@var{x})
+## @deftypefn {} {@var{y} =} acsch (@var{x})
 ## Compute the inverse hyperbolic cosecant of each element of @var{x}.
 ## @seealso{csch}
 ## @end deftypefn
--- a/scripts/elfun/asec.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/asec.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} asec (@var{x})
+## @deftypefn {} {@var{y} =} asec (@var{x})
 ## Compute the inverse secant in radians for each element of @var{x}.
 ## @seealso{sec, asecd}
 ## @end deftypefn
--- a/scripts/elfun/asecd.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/asecd.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} asecd (@var{x})
+## @deftypefn {} {@var{y} =} asecd (@var{x})
 ## Compute the inverse secant in degrees for each element of @var{x}.
 ## @seealso{secd, asec}
 ## @end deftypefn
--- a/scripts/elfun/asech.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/asech.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} asech (@var{x})
+## @deftypefn {} {@var{y} =} asech (@var{x})
 ## Compute the inverse hyperbolic secant of each element of @var{x}.
 ## @seealso{sech}
 ## @end deftypefn
--- a/scripts/elfun/asind.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/asind.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} asind (@var{x})
+## @deftypefn {} {@var{y} =} asind (@var{x})
 ## Compute the inverse sine in degrees for each element of @var{x}.
 ## @seealso{sind, asin}
 ## @end deftypefn
--- a/scripts/elfun/atan2d.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/atan2d.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,19 +24,19 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} atan2d (@var{y}, @var{x})
+## @deftypefn {} {@var{d} =} atan2d (@var{y}, @var{x})
 ## Compute atan (@var{y} / @var{x}) in degrees for corresponding elements
 ## from @var{y} and @var{x}.
 ## @seealso{tand, atan2}
 ## @end deftypefn
 
-function retval = atan2d (y, x)
+function d = atan2d (y, x)
 
   if (nargin != 2)
     print_usage ();
   endif
 
-  retval = 180 ./ pi .* atan2 (y, x);
+  d = 180 ./ pi .* atan2 (y, x);
 
 endfunction
 
--- a/scripts/elfun/atand.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/atand.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} atand (@var{x})
+## @deftypefn {} {@var{y} =} atand (@var{x})
 ## Compute the inverse tangent in degrees for each element of @var{x}.
 ## @seealso{tand, atan}
 ## @end deftypefn
--- a/scripts/elfun/cosd.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/cosd.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} cosd (@var{x})
+## @deftypefn {} {@var{y} =} cosd (@var{x})
 ## Compute the cosine for each element of @var{x} in degrees.
 ##
 ## The function is more accurate than @code{cos} for large values of @var{x}
--- a/scripts/elfun/cot.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/cot.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} cot (@var{x})
+## @deftypefn {} {@var{y} =} cot (@var{x})
 ## Compute the cotangent for each element of @var{x} in radians.
 ## @seealso{acot, cotd, coth}
 ## @end deftypefn
--- a/scripts/elfun/cotd.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/cotd.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} cotd (@var{x})
+## @deftypefn {} {@var{y} =} cotd (@var{x})
 ## Compute the cotangent for each element of @var{x} in degrees.
 ## @seealso{acotd, cot}
 ## @end deftypefn
--- a/scripts/elfun/coth.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/coth.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} coth (@var{x})
+## @deftypefn {} {@var{y} =} coth (@var{x})
 ## Compute the hyperbolic cotangent of each element of @var{x}.
 ## @seealso{acoth}
 ## @end deftypefn
--- a/scripts/elfun/csc.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/csc.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} csc (@var{x})
+## @deftypefn {} {@var{y} =} csc (@var{x})
 ## Compute the cosecant for each element of @var{x} in radians.
 ## @seealso{acsc, cscd, csch}
 ## @end deftypefn
--- a/scripts/elfun/cscd.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/cscd.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} cscd (@var{x})
+## @deftypefn {} {@var{y} =} cscd (@var{x})
 ## Compute the cosecant for each element of @var{x} in degrees.
 ## @seealso{acscd, csc}
 ## @end deftypefn
--- a/scripts/elfun/csch.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/csch.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} csch (@var{x})
+## @deftypefn {} {@var{y} =} csch (@var{x})
 ## Compute the hyperbolic cosecant of each element of @var{x}.
 ## @seealso{acsch}
 ## @end deftypefn
--- a/scripts/elfun/sec.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/sec.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} sec (@var{x})
+## @deftypefn {} {@var{y} =} sec (@var{x})
 ## Compute the secant for each element of @var{x} in radians.
 ## @seealso{asec, secd, sech}
 ## @end deftypefn
--- a/scripts/elfun/secd.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/secd.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} secd (@var{x})
+## @deftypefn {} {@var{y} =} secd (@var{x})
 ## Compute the secant for each element of @var{x} in degrees.
 ## @seealso{asecd, sec}
 ## @end deftypefn
--- a/scripts/elfun/sech.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/sech.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} sech (@var{x})
+## @deftypefn {} {@var{y} =} sech (@var{x})
 ## Compute the hyperbolic secant of each element of @var{x}.
 ## @seealso{asech}
 ## @end deftypefn
--- a/scripts/elfun/sind.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/sind.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} sind (@var{x})
+## @deftypefn {} {@var{y} =} sind (@var{x})
 ## Compute the sine for each element of @var{x} in degrees.
 ##
 ## The function is more accurate than @code{sin} for large values of @var{x}
--- a/scripts/elfun/tand.m	Mon Dec 27 19:53:35 2021 -0800
+++ b/scripts/elfun/tand.m	Mon Dec 27 20:04:52 2021 -0800
@@ -24,7 +24,7 @@
 ########################################################################
 
 ## -*- texinfo -*-
-## @deftypefn {} {} tand (@var{x})
+## @deftypefn {} {@var{y} =} tand (@var{x})
 ## Compute the tangent for each element of @var{x} in degrees.
 ##
 ## Returns zero for elements where @code{@var{x}/180} is an integer and