[Scipy-tickets] [SciPy] #356: docstring typo in scipy.cluster

SciPy scipy-tickets at scipy.net
Tue Jan 23 10:46:26 CST 2007


#356: docstring typo in scipy.cluster
---------------------------+------------------------------------------------
 Reporter:  vmas           |       Owner:  somebody  
     Type:  enhancement    |      Status:  new       
 Priority:  normal         |   Milestone:            
Component:  scipy.cluster  |     Version:            
 Severity:  trivial        |    Keywords:  cluster vq
---------------------------+------------------------------------------------
 In the module scipy.cluster.vq the docstrings of vq method have a couple
 of typos. They say:

 {{{


                             #   c0    c1    c2   c3
                 code_book = [[  1.,   2.,   3.,   4.],  #f0
                              [  1.,   2.,   3.,   4.],  #f1
                              [  1.,   2.,   3.,   4.]]) #f2

 Outputs:
     code -- 1D array.
             If obs is a NxM array, then a length M array
 }}}

 but should say:

 {{{


                             #   f0    f1    f2   f3
                 code_book = [[  1.,   2.,   3.,   4.],  #c0
                              [  1.,   2.,   3.,   4.],  #c1
                              [  1.,   2.,   3.,   4.]]) #c2


 Outputs:
     code -- 1D array.
             If obs is a NxM array, then a length N array
 }}}

 The typos can be rather confusing, specially if you are new to cluster
 methods.

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


More information about the Scipy-tickets mailing list