Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html

changeset 2938
42d82e978d27
parent 2929
28ab0bc63d69
child 2950
d568932e5185
equal deleted inserted replaced
2937:de26bc76d6ee 2938:42d82e978d27
91 <td>Private method to check, that docstrings contain an @param line for each argument.</td> 91 <td>Private method to check, that docstrings contain an @param line for each argument.</td>
92 </tr><tr> 92 </tr><tr>
93 <td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td> 93 <td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td>
94 <td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td> 94 <td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td>
95 </tr><tr> 95 </tr><tr>
96 <td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClass">__checkEricNoBlankBeforeAndAfterClass</a></td> 96 <td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td>
97 <td>Private method to check, that class docstrings have no blank line around them.</td> 97 <td>Private method to check, that class and function/method docstrings have no blank line around them.</td>
98 </tr><tr> 98 </tr><tr>
99 <td><a href="#Pep257Checker.__checkEricOneLiner">__checkEricOneLiner</a></td> 99 <td><a href="#Pep257Checker.__checkEricOneLiner">__checkEricOneLiner</a></td>
100 <td>Private method to check, that one-liner docstrings are on three lines (quotes, docstring, quotes).</td> 100 <td>Private method to check, that one-liner docstrings are on three lines (quotes, docstring, quotes).</td>
101 </tr><tr> 101 </tr><tr>
102 <td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td> 102 <td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td>
357 docstring context (Pep257Context) 357 docstring context (Pep257Context)
358 </dd><dt><i>context</i></dt> 358 </dd><dt><i>context</i></dt>
359 <dd> 359 <dd>
360 context of the docstring (Pep257Context) 360 context of the docstring (Pep257Context)
361 </dd> 361 </dd>
362 </dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass"></a> 362 </dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a>
363 <h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClass</h4> 363 <h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4>
364 <b>__checkEricNoBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) 364 <b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>)
365 <p> 365 <p>
366 Private method to check, that class docstrings have no blank line 366 Private method to check, that class and function/method docstrings
367 around them. 367 have no blank line around them.
368 </p><dl> 368 </p><dl>
369 <dt><i>docstringContext</i></dt> 369 <dt><i>docstringContext</i></dt>
370 <dd> 370 <dd>
371 docstring context (Pep257Context) 371 docstring context (Pep257Context)
372 </dd><dt><i>context</i></dt> 372 </dd><dt><i>context</i></dt>

eric ide

mercurial