[Numpy-tickets] [NumPy] #795: How to document classes, methods, attributes?

NumPy numpy-tickets@scipy....
Sun Aug 17 10:02:44 CDT 2008


#795: How to document classes, methods, attributes?
-------------------------+--------------------------------------------------
 Reporter:  pearu        |        Owner:  stefan
     Type:  enhancement  |       Status:  new   
 Priority:  normal       |    Milestone:  1.2.0 
Component:  numpy.core   |      Version:  none  
 Severity:  normal       |   Resolution:        
 Keywords:               |  
-------------------------+--------------------------------------------------
Comment (by pv):

 Some work was done to clear this up:

     http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines
 #documenting-classes

 It would seem OK to me to copy the docstring automatically, but only if
 the functionality of the derived function is exactly the same as that in
 the base class. Otherwise, it might be better, for maintainability, to
 write a new docstring referring to the original function, eg.
 http://sd-2116.dedibox.fr/pydocweb/doc/numpy.ndarray.cumprod/

-- 
Ticket URL: <http://scipy.org/scipy/numpy/ticket/795#comment:3>
NumPy <http://projects.scipy.org/scipy/numpy>
The fundamental package needed for scientific computing with Python.


More information about the Numpy-tickets mailing list