[Scipy-tickets] [SciPy] #1844: DOC BUG: Problem with HTML documentation generation for the 'Parameters' section of docstrings

SciPy Trac scipy-tickets@scipy....
Fri Feb 15 00:34:28 CST 2013


#1844: DOC BUG: Problem with HTML documentation generation for the 'Parameters'
section of docstrings
---------------------------------+------------------------------------------
 Reporter:  warren.weckesser     |       Owner:  pv         
     Type:  defect               |      Status:  new        
 Priority:  normal               |   Milestone:  Unscheduled
Component:  Documentation        |     Version:  0.11.0     
 Keywords:  documentation, HTML  |  
---------------------------------+------------------------------------------

Comment(by warren.weckesser):

 Here's the problem: the code that parses the docstring (from the numpydoc
 Sphinx extension) expects the 'Parameters' section to contain *only* the
 parameter list.  In the docstrings for the stats distributions and for
 pchip (and probably other objects), there are additional lines in the
 'Parameters' section that aren't part of the parameter list.

 The simplest fix is to move the lines that aren't actually part of the
 parameter list to either the extended summary or to the 'Notes' section.

-- 
Ticket URL: <http://projects.scipy.org/scipy/ticket/1844#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