Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing message translations for the code style plugin messages. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>_fixMessages</td></tr><tr><td>_fixMessagesSampleArgs</td></tr><tr><td>_pycodestyleErrorMessages</td></tr><tr><td>_pycodestyleErrorMessagesSampleArgs</td></tr><tr><td>_pycodestyleWarningMessages</td></tr><tr><td>_pycodestyleWarningMessagesSampleArgs</td></tr><tr><td>messageCatalogs</td></tr><tr><td>messageCategoryRe</td></tr><tr><td>messageSampleArgsCatalog</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#getMessageCodes">getMessageCodes</a></td> | |
| 30 <td>Module function to get a list of known message codes.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#getTranslatedMessage">getTranslatedMessage</a></td> | |
| 34 <td>Module function to get a translated and formatted message for a given message ID.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="getMessageCodes" ID="getMessageCodes"></a> | |
| 40 <h2>getMessageCodes</h2> | |
| 41 <b>getMessageCodes</b>(<i></i>) | |
| 42 | |
| 43 <p> | |
| 44 Module function to get a list of known message codes. | |
| 45 </p> | |
| 46 <dl> | |
| 47 <dt>Return:</dt> | |
| 48 <dd> | |
| 49 list of known message codes | |
| 50 </dd> | |
| 51 </dl> | |
| 52 <dl> | |
| 53 <dt>Return Type:</dt> | |
| 54 <dd> | |
| 55 set of str | |
| 56 </dd> | |
| 57 </dl> | |
| 58 <div align="right"><a href="#top">Up</a></div> | |
| 59 <hr /> | |
| 60 <hr /> | |
| 61 <a NAME="getTranslatedMessage" ID="getTranslatedMessage"></a> | |
| 62 <h2>getTranslatedMessage</h2> | |
| 63 <b>getTranslatedMessage</b>(<i>messageCode, messageArgs, example=False</i>) | |
| 64 | |
| 65 <p> | |
| 66 Module function to get a translated and formatted message for a | |
| 67 given message ID. | |
| 68 </p> | |
| 69 <dl> | |
| 70 | |
| 71 <dt><i>messageCode</i> (str)</dt> | |
| 72 <dd> | |
| 73 the message code | |
| 74 </dd> | |
| 75 <dt><i>messageArgs</i> (list or int)</dt> | |
| 76 <dd> | |
| 77 list of arguments or a single integer value to format | |
| 78 the message | |
| 79 </dd> | |
| 80 <dt><i>example</i> (bool)</dt> | |
| 81 <dd> | |
| 82 flag indicating a translated message filled with example | |
| 83 data is requested (messageArgs is ignored if given) | |
| 84 </dd> | |
| 85 </dl> | |
| 86 <dl> | |
| 87 <dt>Return:</dt> | |
| 88 <dd> | |
| 89 translated and formatted message | |
| 90 </dd> | |
| 91 </dl> | |
| 92 <dl> | |
| 93 <dt>Return Type:</dt> | |
| 94 <dd> | |
| 95 str | |
| 96 </dd> | |
| 97 </dl> | |
| 98 <div align="right"><a href="#top">Up</a></div> | |
| 99 <hr /> | |
| 100 </body></html> |
