[Python-modules-team] Bug#474930: python-scipy: docstring for leastsq (in scipy.optimize) incorrectly describes 'ier'

[Andrzej Novak]

Package: python-scipy
Version: 0.6.0-5.1
Severity: minor


Docstring for leastsq incorrectly describes the returned variable
ier. It states,

    ier -- an integer flag.  If it is equal to 1 the solution was
           found.  If it is not equal to 1, the solution was not
           found and the following message gives more information.

This is correct for "fsolve"; however, for leastsq, ier values of 1, 2,
3 and 4 all indicate no errors (see the definition of "errors" within
the function in 
/usr/share/pycentral/python-scipy/site-packages/scipy/optimize/minpack.py).

Regards,

Andrzej

-- System Information:
Debian Release: lenny/sid
  APT prefers testing
  APT policy: (650, 'testing'), (600, 'unstable')
Architecture: i386 (i686)

Kernel: Linux 2.6.24-1-686-bigmem (SMP w/2 CPU cores)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/bash

Versions of packages python-scipy depends on:
ii  atlas3-base [liblapack 3.6.0-20.6        Automatically Tuned Linear Algebra
ii  lapack3 [liblapack.so. 3.0.20000531a-6.1 library of linear algebra routines
ii  libc6                  2.7-10            GNU C Library: Shared libraries
ii  libfftw3-3             3.1.2-3           library for computing Fast Fourier
ii  libg2c0                1:3.4.6-6         Runtime library for GNU Fortran 77
ii  libgcc1                1:4.3.0-1         GCC support library
ii  libstdc++6             4.3.0-1           The GNU Standard C++ Library v3
ii  libsuitesparse         3.0.0-7           collection of libraries for comput
ii  python                 2.4.4-6           An interactive high-level object-o
ii  python-central         0.6.1             register and build utility for Pyt
ii  python-imaging         1.1.6-1           Python Imaging Library
ii  python-numpy           1:1.0.4-5         Numerical Python adds a fast array
ii  refblas3 [libblas.so.3 1.2-8             Basic Linear Algebra Subroutines 3

Versions of packages python-scipy recommends:
ii  g++ [c++-compiler]            4:4.2.2-2  The GNU C++ compiler
ii  g++-4.1 [c++-compiler]        4.1.2-19   The GNU C++ compiler
ii  g++-4.2 [c++-compiler]        4.2.3-3    The GNU C++ compiler

-- no debconf information