[Scipy-tickets] [SciPy] #1845: DOC BUG: HTML generated for sparse matrices is incorrect.

SciPy Trac scipy-tickets@scipy....
Fri Feb 15 08:06:57 CST 2013


#1845: DOC BUG: HTML generated for sparse matrices is incorrect.
------------------------------+---------------------------------------------
 Reporter:  warren.weckesser  |       Owner:  pv         
     Type:  defect            |      Status:  new        
 Priority:  normal            |   Milestone:  Unscheduled
Component:  Documentation     |     Version:  0.11.0     
 Keywords:  HTML              |  
------------------------------+---------------------------------------------

Comment(by pv):

 This is a numpydoc issue. There's a technical difficulty: `data`,
 `indices` and `indptr` are not properties and do not have docstrings, and
 so they are not included in Sphinx's autosummary:: directive.

 Unfortunately, autosummary:: is married both with the autogeneration of
 documentation and the visual display. In hindsight, this was a misguided
 design...

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


More information about the Scipy-tickets mailing list