Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
- changeset 3582
- 49f9c3695ef5
- parent 3484
- 645c12de6b0c
equal
deleted
inserted
replaced
| 3581:03b351be4436 | 3582:49f9c3695ef5 |
|---|---|
| 103 <td>Private method to check, that leading and trailing quotes are on a line by themselves.</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="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td> | 105 <td><a href="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td> |
| 106 <td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td> | 106 <td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td> |
| 107 </tr><tr> | 107 </tr><tr> |
| 108 <td><a href="#DocStyleChecker.__checkEricSummary">__checkEricSummary</a></td> | |
| 109 <td>Private method to check, that method docstring summaries start with specific words.</td> | |
| 110 </tr><tr> | |
| 108 <td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> | 111 <td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> |
| 109 <td>Private method to check, that all public functions and methods have a docstring.</td> | 112 <td>Private method to check, that all public functions and methods have a docstring.</td> |
| 110 </tr><tr> | 113 </tr><tr> |
| 111 <td><a href="#DocStyleChecker.__checkImperativeMood">__checkImperativeMood</a></td> | 114 <td><a href="#DocStyleChecker.__checkImperativeMood">__checkImperativeMood</a></td> |
| 112 <td>Private method to check, that docstring summaries are in imperative mood.</td> | 115 <td>Private method to check, that docstring summaries are in imperative mood.</td> |
| 414 <h4>DocStyleChecker.__checkEricReturn</h4> | 417 <h4>DocStyleChecker.__checkEricReturn</h4> |
| 415 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) | 418 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) |
| 416 <p> | 419 <p> |
| 417 Private method to check, that docstrings contain an @return line | 420 Private method to check, that docstrings contain an @return line |
| 418 if they return anything and don't otherwise. | 421 if they return anything and don't otherwise. |
| 422 </p><dl> | |
| 423 <dt><i>docstringContext</i></dt> | |
| 424 <dd> | |
| 425 docstring context (DocStyleContext) | |
| 426 </dd><dt><i>context</i></dt> | |
| 427 <dd> | |
| 428 context of the docstring (DocStyleContext) | |
| 429 </dd> | |
| 430 </dl><a NAME="DocStyleChecker.__checkEricSummary" ID="DocStyleChecker.__checkEricSummary"></a> | |
| 431 <h4>DocStyleChecker.__checkEricSummary</h4> | |
| 432 <b>__checkEricSummary</b>(<i>docstringContext, context</i>) | |
| 433 <p> | |
| 434 Private method to check, that method docstring summaries start with | |
| 435 specific words. | |
| 419 </p><dl> | 436 </p><dl> |
| 420 <dt><i>docstringContext</i></dt> | 437 <dt><i>docstringContext</i></dt> |
| 421 <dd> | 438 <dd> |
| 422 docstring context (DocStyleContext) | 439 docstring context (DocStyleContext) |
| 423 </dd><dt><i>context</i></dt> | 440 </dd><dt><i>context</i></dt> |
