[Pkg-octave-devel] Bug#335373: octave2.1: extraneous argument in lgamma docs [patch]
Package: octave2.1
Version: 2.1.69-1
Severity: normal
The documentation for lgamma indicates it requires two arguments, but
doesn't say what they are:
octave:1> help lgamma
lgamma is a built-in mapper function
-- Mapping Function: lgamma (A, X)
-- Mapping Function: gammaln (A, X)
Return the natural logarithm of the gamma function.
See also: gamma and gammai.
Apparently only one argument is allowed:
octave:2> lgamma(2,3)
error: lgamma: too many arguments
I suggest the first argument be removed from the documentation string,
as with the following patch.
- Jim Van Zandt
--- src/mappers.cc-old 2005-10-23 10:30:40.000000000 -0400
+++ src/mappers.cc 2005-10-23 10:31:40.000000000 -0400
@@ -537,8 +537,8 @@
DEFUN_MAPPER (lgamma, 0, 0, 0, xlgamma, 0, 0, 0.0, 0.0, 0, 0,
"-*- texinfo -*-\n\
-@deftypefn {Mapping Function} {} lgamma (@var{a}, @var{x})\n\
-@deftypefnx {Mapping Function} {} gammaln (@var{a}, @var{x})\n\
+@deftypefn {Mapping Function} {} lgamma (@var{x})\n\
+@deftypefnx {Mapping Function} {} gammaln (@var{x})\n\
Return the natural logarithm of the gamma function.\n\
@end deftypefn\n\
@seealso{gamma and gammai}");
-- System Information:
Debian Release: testing/unstable
APT prefers testing
APT policy: (990, 'testing'), (500, 'oldstable'), (500, 'unstable')
Architecture: i386 (i686)
Shell: /bin/sh linked to /bin/bash
Kernel: Linux 2.4.29
Locale: LANG=C, LC_CTYPE=C (charmap=ANSI_X3.4-1968)
Versions of packages octave2.1 depends on:
ii atlas3-base [liblapack.s 3.6.0-19 Automatically Tuned Linear Algebra
ii fftw3 3.0.1-14 library for computing Fast Fourier
ii lapack3 [liblapack.so.3] 3.0.20000531a-6 library of linear algebra routines
ii libc6 2.3.5-6 GNU C Library: Shared libraries an
ii libg2c0 1:3.4.4-8 Runtime library for GNU Fortran 77
ii libgcc1 1:4.0.2-2 GCC support library
ii libhdf5-serial-1.6.2-0 [ 1.6.2-3 Hierarchical Data Format 5 (HDF5)
ii libncurses5 5.4-9 Shared libraries for terminal hand
ii libreadline5 5.0-10 GNU readline and history libraries
ii libstdc++5 1:3.3.6-7 The GNU Standard C++ Library v3
ii texinfo 4.8-1 Documentation system for on-line i
ii zlib1g 1:1.2.3-4 compression library - runtime
octave2.1 recommends no packages.
-- no debconf information
Reply to: