Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html
Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html
- changeset 2950
- d568932e5185
- parent 2938
- 42d82e978d27
equal
deleted
inserted
replaced
| 2949:e8f41288a688 | 2950:d568932e5185 |
|---|---|
| 85 <td>Private method to check, that docstring summaries are followed by a blank line.</td> | 85 <td>Private method to check, that docstring summaries are followed by a blank line.</td> |
| 86 </tr><tr> | 86 </tr><tr> |
| 87 <td><a href="#Pep257Checker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> | 87 <td><a href="#Pep257Checker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> |
| 88 <td>Private method to check, that docstring summaries end with a period.</td> | 88 <td>Private method to check, that docstring summaries end with a period.</td> |
| 89 </tr><tr> | 89 </tr><tr> |
| 90 <td><a href="#Pep257Checker.__checkEricException">__checkEricException</a></td> | |
| 91 <td>Private method to check, that docstrings contain an @exception line if they raise an exception and don't otherwise.</td> | |
| 92 </tr><tr> | |
| 90 <td><a href="#Pep257Checker.__checkEricFunctionArguments">__checkEricFunctionArguments</a></td> | 93 <td><a href="#Pep257Checker.__checkEricFunctionArguments">__checkEricFunctionArguments</a></td> |
| 91 <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 and/or @keyparam line for each argument.</td> |
| 92 </tr><tr> | 95 </tr><tr> |
| 93 <td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td> | 96 <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> | 97 <td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td> |
| 95 </tr><tr> | 98 </tr><tr> |
| 96 <td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> | 99 <td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> |
| 97 <td>Private method to check, that class and function/method 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> |
| 98 </tr><tr> | 101 </tr><tr> |
| 99 <td><a href="#Pep257Checker.__checkEricOneLiner">__checkEricOneLiner</a></td> | 102 <td><a href="#Pep257Checker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td> |
| 100 <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> |
| 101 </tr><tr> | 104 </tr><tr> |
| 102 <td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td> | 105 <td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td> |
| 103 <td>Private method to check, that docstrings contain an @return line.</td> | 106 <td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td> |
| 104 </tr><tr> | 107 </tr><tr> |
| 105 <td><a href="#Pep257Checker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> | 108 <td><a href="#Pep257Checker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> |
| 106 <td>Private method to check, that all public functions and methods have a docstring.</td> | 109 <td>Private method to check, that all public functions and methods have a docstring.</td> |
| 107 </tr><tr> | 110 </tr><tr> |
| 108 <td><a href="#Pep257Checker.__checkImperativeMood">__checkImperativeMood</a></td> | 111 <td><a href="#Pep257Checker.__checkImperativeMood">__checkImperativeMood</a></td> |
| 329 docstring context (Pep257Context) | 332 docstring context (Pep257Context) |
| 330 </dd><dt><i>context</i></dt> | 333 </dd><dt><i>context</i></dt> |
| 331 <dd> | 334 <dd> |
| 332 context of the docstring (Pep257Context) | 335 context of the docstring (Pep257Context) |
| 333 </dd> | 336 </dd> |
| 337 </dl><a NAME="Pep257Checker.__checkEricException" ID="Pep257Checker.__checkEricException"></a> | |
| 338 <h4>Pep257Checker.__checkEricException</h4> | |
| 339 <b>__checkEricException</b>(<i>docstringContext, context</i>) | |
| 340 <p> | |
| 341 Private method to check, that docstrings contain an @exception line | |
| 342 if they raise an exception and don't otherwise. | |
| 343 </p><dl> | |
| 344 <dt><i>docstringContext</i></dt> | |
| 345 <dd> | |
| 346 docstring context (Pep257Context) | |
| 347 </dd><dt><i>context</i></dt> | |
| 348 <dd> | |
| 349 context of the docstring (Pep257Context) | |
| 350 </dd> | |
| 334 </dl><a NAME="Pep257Checker.__checkEricFunctionArguments" ID="Pep257Checker.__checkEricFunctionArguments"></a> | 351 </dl><a NAME="Pep257Checker.__checkEricFunctionArguments" ID="Pep257Checker.__checkEricFunctionArguments"></a> |
| 335 <h4>Pep257Checker.__checkEricFunctionArguments</h4> | 352 <h4>Pep257Checker.__checkEricFunctionArguments</h4> |
| 336 <b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>) | 353 <b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>) |
| 337 <p> | 354 <p> |
| 338 Private method to check, that docstrings contain an @param line | 355 Private method to check, that docstrings contain an @param and/or |
| 339 for each argument. | 356 @keyparam line for each argument. |
| 340 </p><dl> | 357 </p><dl> |
| 341 <dt><i>docstringContext</i></dt> | 358 <dt><i>docstringContext</i></dt> |
| 342 <dd> | 359 <dd> |
| 343 docstring context (Pep257Context) | 360 docstring context (Pep257Context) |
| 344 </dd><dt><i>context</i></dt> | 361 </dd><dt><i>context</i></dt> |
| 371 docstring context (Pep257Context) | 388 docstring context (Pep257Context) |
| 372 </dd><dt><i>context</i></dt> | 389 </dd><dt><i>context</i></dt> |
| 373 <dd> | 390 <dd> |
| 374 context of the docstring (Pep257Context) | 391 context of the docstring (Pep257Context) |
| 375 </dd> | 392 </dd> |
| 376 </dl><a NAME="Pep257Checker.__checkEricOneLiner" ID="Pep257Checker.__checkEricOneLiner"></a> | 393 </dl><a NAME="Pep257Checker.__checkEricQuotesOnSeparateLines" ID="Pep257Checker.__checkEricQuotesOnSeparateLines"></a> |
| 377 <h4>Pep257Checker.__checkEricOneLiner</h4> | 394 <h4>Pep257Checker.__checkEricQuotesOnSeparateLines</h4> |
| 378 <b>__checkEricOneLiner</b>(<i>docstringContext, context</i>) | 395 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) |
| 379 <p> | 396 <p> |
| 380 Private method to check, that one-liner docstrings are on | 397 Private method to check, that leading and trailing quotes are on |
| 381 three lines (quotes, docstring, quotes). | 398 a line by themselves. |
| 382 </p><dl> | 399 </p><dl> |
| 383 <dt><i>docstringContext</i></dt> | 400 <dt><i>docstringContext</i></dt> |
| 384 <dd> | 401 <dd> |
| 385 docstring context (Pep257Context) | 402 docstring context (Pep257Context) |
| 386 </dd><dt><i>context</i></dt> | 403 </dd><dt><i>context</i></dt> |
| 389 </dd> | 406 </dd> |
| 390 </dl><a NAME="Pep257Checker.__checkEricReturn" ID="Pep257Checker.__checkEricReturn"></a> | 407 </dl><a NAME="Pep257Checker.__checkEricReturn" ID="Pep257Checker.__checkEricReturn"></a> |
| 391 <h4>Pep257Checker.__checkEricReturn</h4> | 408 <h4>Pep257Checker.__checkEricReturn</h4> |
| 392 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) | 409 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) |
| 393 <p> | 410 <p> |
| 394 Private method to check, that docstrings contain an @return line. | 411 Private method to check, that docstrings contain an @return line |
| 412 if they return anything and don't otherwise. | |
| 395 </p><dl> | 413 </p><dl> |
| 396 <dt><i>docstringContext</i></dt> | 414 <dt><i>docstringContext</i></dt> |
| 397 <dd> | 415 <dd> |
| 398 docstring context (Pep257Context) | 416 docstring context (Pep257Context) |
| 399 </dd><dt><i>context</i></dt> | 417 </dd><dt><i>context</i></dt> |
| 637 Private method to extract a docstring given `def` or `class` source. | 655 Private method to extract a docstring given `def` or `class` source. |
| 638 </p><dl> | 656 </p><dl> |
| 639 <dt><i>context</i></dt> | 657 <dt><i>context</i></dt> |
| 640 <dd> | 658 <dd> |
| 641 context data to get the docstring from (Pep257Context) | 659 context data to get the docstring from (Pep257Context) |
| 660 </dd><dt><i>what</i></dt> | |
| 661 <dd> | |
| 662 string denoting what is being parsed (string) | |
| 642 </dd> | 663 </dd> |
| 643 </dl><dl> | 664 </dl><dl> |
| 644 <dt>Returns:</dt> | 665 <dt>Returns:</dt> |
| 645 <dd> | 666 <dd> |
| 646 context of extracted docstring (Pep257Context) | 667 context of extracted docstring (Pep257Context) |
