[Scipy-tickets] [SciPy] #1154: Wiener filter docstring has wrong keyword/arg names

SciPy Trac scipy-tickets@scipy....
Tue Apr 13 15:43:12 CDT 2010


#1154: Wiener filter docstring has wrong keyword/arg names
-----------------------------+----------------------------------------------
 Reporter:  andrew.collette  |       Owner:  pv   
     Type:  defect           |      Status:  new  
 Priority:  normal           |   Milestone:  0.8.0
Component:  Documentation    |     Version:  0.7.0
 Keywords:                   |  
-----------------------------+----------------------------------------------
 The docstring for scipy.signal.wiener refers to keyword argument
 "kernel_size" while the appropriate keyword appears to be "mysize".  The
 name of the first argument also disagrees ("in" vs. "im").

 The documented format for the return value is also confusing.  Why does
 the docstring suggest it's wrapped in a tuple?

 http://projects.scipy.org/scipy/browser/trunk/scipy/signal/signaltools.py#L311

-- 
Ticket URL: <http://projects.scipy.org/scipy/ticket/1154>
SciPy <http://www.scipy.org>
SciPy is open-source software for mathematics, science, and engineering.


More information about the Scipy-tickets mailing list