Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html
Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html
- changeset 2938
- 42d82e978d27
- parent 2929
- 28ab0bc63d69
- child 2950
- d568932e5185
equal
deleted
inserted
replaced
| 2937:de26bc76d6ee | 2938:42d82e978d27 |
|---|---|
| 94 <td>Private method to check, that docstrings contain an @param line for each argument.</td> | 94 <td>Private method to check, that docstrings contain an @param line for each argument.</td> |
| 95 </tr><tr> | 95 </tr><tr> |
| 96 <td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td> | 96 <td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td> |
| 97 <td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td> | 97 <td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td> |
| 98 </tr><tr> | 98 </tr><tr> |
| 99 <td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClass">__checkEricNoBlankBeforeAndAfterClass</a></td> | 99 <td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> |
| 100 <td>Private method to check, that class docstrings have no blank line around them.</td> | 100 <td>Private method to check, that class and function/method docstrings have no blank line around them.</td> |
| 101 </tr><tr> | 101 </tr><tr> |
| 102 <td><a href="#Pep257Checker.__checkEricOneLiner">__checkEricOneLiner</a></td> | 102 <td><a href="#Pep257Checker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td> |
| 103 <td>Private method to check, that one-liner docstrings are on three lines (quotes, docstring, quotes).</td> | 103 <td>Private method to check, that leading and trailing quotes are on a line by themselves.</td> |
| 104 </tr><tr> | 104 </tr><tr> |
| 105 <td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td> | 105 <td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td> |
| 106 <td>Private method to check, that docstrings contain an @return line.</td> | 106 <td>Private method to check, that docstrings contain an @return line.</td> |
| 107 </tr><tr> | 107 </tr><tr> |
| 108 <td><a href="#Pep257Checker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> | 108 <td><a href="#Pep257Checker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> |
| 379 docstring context (Pep257Context) | 379 docstring context (Pep257Context) |
| 380 </dd><dt><i>context</i></dt> | 380 </dd><dt><i>context</i></dt> |
| 381 <dd> | 381 <dd> |
| 382 context of the docstring (Pep257Context) | 382 context of the docstring (Pep257Context) |
| 383 </dd> | 383 </dd> |
| 384 </dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass"></a> | 384 </dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> |
| 385 <h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClass</h4> | 385 <h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4> |
| 386 <b>__checkEricNoBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) | 386 <b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>) |
| 387 <p> | 387 <p> |
| 388 Private method to check, that class docstrings have no blank line | 388 Private method to check, that class and function/method docstrings |
| 389 around them. | 389 have no blank line around them. |
| 390 </p><dl> | 390 </p><dl> |
| 391 <dt><i>docstringContext</i></dt> | 391 <dt><i>docstringContext</i></dt> |
| 392 <dd> | 392 <dd> |
| 393 docstring context (Pep257Context) | 393 docstring context (Pep257Context) |
| 394 </dd><dt><i>context</i></dt> | 394 </dd><dt><i>context</i></dt> |
| 395 <dd> | 395 <dd> |
| 396 context of the docstring (Pep257Context) | 396 context of the docstring (Pep257Context) |
| 397 </dd> | 397 </dd> |
| 398 </dl><a NAME="Pep257Checker.__checkEricOneLiner" ID="Pep257Checker.__checkEricOneLiner"></a> | 398 </dl><a NAME="Pep257Checker.__checkEricQuotesOnSeparateLines" ID="Pep257Checker.__checkEricQuotesOnSeparateLines"></a> |
| 399 <h4>Pep257Checker.__checkEricOneLiner</h4> | 399 <h4>Pep257Checker.__checkEricQuotesOnSeparateLines</h4> |
| 400 <b>__checkEricOneLiner</b>(<i>docstringContext, context</i>) | 400 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) |
| 401 <p> | 401 <p> |
| 402 Private method to check, that one-liner docstrings are on | 402 Private method to check, that leading and trailing quotes are on |
| 403 three lines (quotes, docstring, quotes). | 403 a line by themselves. |
| 404 </p><dl> | 404 </p><dl> |
| 405 <dt><i>docstringContext</i></dt> | 405 <dt><i>docstringContext</i></dt> |
| 406 <dd> | 406 <dd> |
| 407 docstring context (Pep257Context) | 407 docstring context (Pep257Context) |
| 408 </dd><dt><i>context</i></dt> | 408 </dd><dt><i>context</i></dt> |
