[Scipy-tickets] [SciPy] #1844: DOC BUG: Problem with HTML documentation generation for the 'Parameters' section of docstrings (was: DOC BUG: Problems with stats distributions documentation generation)

SciPy Trac scipy-tickets@scipy....
Fri Feb 15 00:02:45 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  |  
---------------------------------+------------------------------------------
Changes (by warren.weckesser):

  * owner:  rgommers => pv
  * component:  scipy.stats => Documentation


Old description:

> The HTML documentation generated for the stats distributions is not
> correct.  An example is
> http://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.norm.html#scipy.stats.norm
>
> The text in the Parameters section that begins "Alternatively, the
> object..." should not be included in the parameters.

New description:

 The HTML documentation generated for the stats distributions is not
 correct.  An example is
 http://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.norm.html#scipy.stats.norm

 The text in the Parameters section that begins "Alternatively, the
 object..." should not be included in the parameters.

 Something similar also happens in the online documentation for
 scipy.interpolate.pchip, so this probably isn't specific to the
 distribution classes in stats.  See
 http://docs.scipy.org/doc/scipy/reference/generated/scipy.interpolate.pchip.html#scipy.interpolate.pchip

 It looks like the code that parses the docstring is not correctly
 detecting the end of the 'Parameters' section.

--

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


More information about the Scipy-tickets mailing list