Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.UtilitiesPython2.DocStyleCheckerPy2.html
Documentation/Source/eric5.UtilitiesPython2.DocStyleCheckerPy2.html
- branch
- Py2 comp.
- changeset 3178
- f25fc1364c88
- parent 3165
- 400234200cd6
equal
deleted
inserted
replaced
| 3161:06f57a834adf | 3178:f25fc1364c88 |
|---|---|
| 127 <td>Private method to check, that one-liner docstrings fit on one line with quotes.</td> | 127 <td>Private method to check, that one-liner docstrings fit on one line with quotes.</td> |
| 128 </tr><tr> | 128 </tr><tr> |
| 129 <td><a href="#DocStyleChecker.__checkReturnType">__checkReturnType</a></td> | 129 <td><a href="#DocStyleChecker.__checkReturnType">__checkReturnType</a></td> |
| 130 <td>Private method to check, that docstrings mention the return value type.</td> | 130 <td>Private method to check, that docstrings mention the return value type.</td> |
| 131 </tr><tr> | 131 </tr><tr> |
| 132 <td><a href="#DocStyleChecker.__checkSummary">__checkSummary</a></td> | |
| 133 <td>Private method to check, that docstring summaries contain some text.</td> | |
| 134 </tr><tr> | |
| 132 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> | 135 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> |
| 133 <td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> | 136 <td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> |
| 134 </tr><tr> | 137 </tr><tr> |
| 135 <td><a href="#DocStyleChecker.__checkUnicode">__checkUnicode</a></td> | 138 <td><a href="#DocStyleChecker.__checkUnicode">__checkUnicode</a></td> |
| 136 <td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td> | 139 <td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td> |
| 517 </dl><a NAME="DocStyleChecker.__checkReturnType" ID="DocStyleChecker.__checkReturnType"></a> | 520 </dl><a NAME="DocStyleChecker.__checkReturnType" ID="DocStyleChecker.__checkReturnType"></a> |
| 518 <h4>DocStyleChecker.__checkReturnType</h4> | 521 <h4>DocStyleChecker.__checkReturnType</h4> |
| 519 <b>__checkReturnType</b>(<i>docstringContext, context</i>) | 522 <b>__checkReturnType</b>(<i>docstringContext, context</i>) |
| 520 <p> | 523 <p> |
| 521 Private method to check, that docstrings mention the return value type. | 524 Private method to check, that docstrings mention the return value type. |
| 525 </p><dl> | |
| 526 <dt><i>docstringContext</i></dt> | |
| 527 <dd> | |
| 528 docstring context (DocStyleContext) | |
| 529 </dd><dt><i>context</i></dt> | |
| 530 <dd> | |
| 531 context of the docstring (DocStyleContext) | |
| 532 </dd> | |
| 533 </dl><a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a> | |
| 534 <h4>DocStyleChecker.__checkSummary</h4> | |
| 535 <b>__checkSummary</b>(<i>docstringContext, context</i>) | |
| 536 <p> | |
| 537 Private method to check, that docstring summaries contain some text. | |
| 522 </p><dl> | 538 </p><dl> |
| 523 <dt><i>docstringContext</i></dt> | 539 <dt><i>docstringContext</i></dt> |
| 524 <dd> | 540 <dd> |
| 525 docstring context (DocStyleContext) | 541 docstring context (DocStyleContext) |
| 526 </dd><dt><i>context</i></dt> | 542 </dd><dt><i>context</i></dt> |
