eric6/Documentation/Source/eric6.QScintilla.DocstringGenerator.NumpydocGenerator.html

<!DOCTYPE html>
<html><head>
<title>eric6.QScintilla.DocstringGenerator.NumpydocGenerator</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric6.QScintilla.DocstringGenerator.NumpydocGenerator</h1>

<p>
Module implementing the docstring generator for the 'numpydoc' style.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#generateNumpyDoc">generateNumpyDoc</a></td>
<td>Function to generate the docstring line list iaw.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="generateNumpyDoc" ID="generateNumpyDoc"></a>
<h2>generateNumpyDoc</h2>
<b>generateNumpyDoc</b>(<i>functionInfo, editor</i>)

<p>
    Function to generate the docstring line list iaw. NumPy documentation
    style.
</p>
<p>
    Note: Text is created with DESCRIPTION placeholders for descriptions and
    TYPE placeholders for type information
</p>
<dl>

<dt><i>functionInfo</i> (FunctionInfo)</dt>
<dd>
object containing the function information to base
        the docstring on
</dd>
<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
list of docstring lines
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>