[SciPy-user] docstrings; corefft, corelinalg

Steve Schmerler elcorto at gmx.net
Fri Dec 30 13:58:17 CST 2005


Hi

I just installed the latest svn versions.

1) Trying to have a look at the doc gives me this

#####################################################################################################################################
In [19]: ?scipy
Type:           module
Base Class:     <type 'module'>
String Form:    <module 'scipy' from 
'/usr/lib/python2.3/site-packages/scipy/__init__.pyc'>
Namespace:      Interactive
File:           /usr/lib/python2.3/site-packages/scipy/__init__.py
Docstring:
     SciPy Core
     ==========

     You can support the development of SciPy by purchasing documentation
     at

       http://www.trelgol.com

     It is being distributed for a fee for a limited time to try and raise
     money for development.

     Documentation is also available in the docstrings.

     Available subpackages
     ---------------------


     SciPy: A scientific computing package for Python
     ================================================

     Available subpackages
     ---------------------


In [20]:
#####################################################################################################################################

... no infos about scipy subpackages (of course `help(scipy)` has some 
infos).


2) I think the doc strings of corefft and corelinalg should contain some 
   words explaining their existence. New scipy users would wonder

* why there is e.g. linalg.inv and corelinalg.inv and why they are the
   same function from .../scipy/linalg/basic.py; same with corefft.fft
   and fftpack.fft and so on

* what the difference between corelinalg.det and corelinalg.determinant
   is (there is none as a look in  .../scipy/corelinalg/linalg.py
   reveals) and why there are two names for the same function

* ....

Is it possible to move all additional functionality of corefft and 
corelinalg to linalg and fftpack (e.g corelinalg.eigh which seems to 
have no equivalent function in linalg).

cheers,
steve

-- 
"People like Blood Sausage too. People are Morons!" -- Phil Connors, 
Groundhog Day



More information about the SciPy-user mailing list