Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
- branch
- Py2 comp.
- changeset 3456
- 96232974dcdb
- parent 3165
- 400234200cd6
- parent 3209
- c5432abceb25
- child 3484
- 645c12de6b0c
equal
deleted
inserted
replaced
| 3178:f25fc1364c88 | 3456:96232974dcdb |
|---|---|
| 23 <p> | 23 <p> |
| 24 Module implementing a checker for documentation string conventions. | 24 Module implementing a checker for documentation string conventions. |
| 25 </p> | 25 </p> |
| 26 <h3>Global Attributes</h3> | 26 <h3>Global Attributes</h3> |
| 27 <table> | 27 <table> |
| 28 <tr><td>PyCF_ONLY_AST</td></tr> | 28 <tr><td>None</td></tr> |
| 29 </table> | 29 </table> |
| 30 <h3>Classes</h3> | 30 <h3>Classes</h3> |
| 31 <table> | 31 <table> |
| 32 <tr> | 32 <tr> |
| 33 <td><a href="#DocStyleChecker">DocStyleChecker</a></td> | 33 <td><a href="#DocStyleChecker">DocStyleChecker</a></td> |
| 49 </p> | 49 </p> |
| 50 <h3>Derived from</h3> | 50 <h3>Derived from</h3> |
| 51 object | 51 object |
| 52 <h3>Class Attributes</h3> | 52 <h3>Class Attributes</h3> |
| 53 <table> | 53 <table> |
| 54 <tr><td>Codes</td></tr><tr><td>Messages</td></tr><tr><td>MessagesSampleArgs</td></tr> | 54 <tr><td>Codes</td></tr> |
| 55 </table> | 55 </table> |
| 56 <h3>Class Methods</h3> | 56 <h3>Class Methods</h3> |
| 57 <table> | 57 <table> |
| 58 <tr> | 58 <tr><td>None</td></tr> |
| 59 <td><a href="#DocStyleChecker.getMessage">getMessage</a></td> | |
| 60 <td>Class method to get a translated and formatted message for a given code.</td> | |
| 61 </tr> | |
| 62 </table> | 59 </table> |
| 63 <h3>Methods</h3> | 60 <h3>Methods</h3> |
| 64 <table> | 61 <table> |
| 65 <tr> | 62 <tr> |
| 66 <td><a href="#DocStyleChecker.__init__">DocStyleChecker</a></td> | 63 <td><a href="#DocStyleChecker.__init__">DocStyleChecker</a></td> |
| 198 </table> | 195 </table> |
| 199 <h3>Static Methods</h3> | 196 <h3>Static Methods</h3> |
| 200 <table> | 197 <table> |
| 201 <tr><td>None</td></tr> | 198 <tr><td>None</td></tr> |
| 202 </table> | 199 </table> |
| 203 <a NAME="DocStyleChecker.getMessage" ID="DocStyleChecker.getMessage"></a> | 200 <a NAME="DocStyleChecker.__init__" ID="DocStyleChecker.__init__"></a> |
| 204 <h4>DocStyleChecker.getMessage (class method)</h4> | |
| 205 <b>getMessage</b>(<i>code, *args</i>) | |
| 206 <p> | |
| 207 Class method to get a translated and formatted message for a | |
| 208 given code. | |
| 209 </p><dl> | |
| 210 <dt><i>code</i></dt> | |
| 211 <dd> | |
| 212 message code (string) | |
| 213 </dd><dt><i>args</i></dt> | |
| 214 <dd> | |
| 215 arguments for a formatted message (list) | |
| 216 </dd> | |
| 217 </dl><dl> | |
| 218 <dt>Returns:</dt> | |
| 219 <dd> | |
| 220 translated and formatted message (string) | |
| 221 </dd> | |
| 222 </dl><a NAME="DocStyleChecker.__init__" ID="DocStyleChecker.__init__"></a> | |
| 223 <h4>DocStyleChecker (Constructor)</h4> | 201 <h4>DocStyleChecker (Constructor)</h4> |
| 224 <b>DocStyleChecker</b>(<i>source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257"</i>) | 202 <b>DocStyleChecker</b>(<i>source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257"</i>) |
| 225 <p> | 203 <p> |
| 226 Constructor | 204 Constructor |
| 227 </p><dl> | 205 </p><dl> |
