Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
- changeset 7641
- 21ea4fd50b0a
- parent 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 7640:f9bb7c8c60d8 | 7641:21ea4fd50b0a |
|---|---|
| 179 <tr> | 179 <tr> |
| 180 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> | 180 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> |
| 181 <td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> | 181 <td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> |
| 182 </tr> | 182 </tr> |
| 183 <tr> | 183 <tr> |
| 184 <td><a href="#DocStyleChecker.__checkUnicode">__checkUnicode</a></td> | |
| 185 <td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td> | |
| 186 </tr> | |
| 187 <tr> | |
| 188 <td><a href="#DocStyleChecker.__error">__error</a></td> | 184 <td><a href="#DocStyleChecker.__error">__error</a></td> |
| 189 <td>Private method to record an issue.</td> | 185 <td>Private method to record an issue.</td> |
| 190 </tr> | 186 </tr> |
| 191 <tr> | 187 <tr> |
| 192 <td><a href="#DocStyleChecker.__getArgNames">__getArgNames</a></td> | 188 <td><a href="#DocStyleChecker.__getArgNames">__getArgNames</a></td> |
| 193 <td></td> | 189 <td>Private method to get the argument names of a function node.</td> |
| 194 </tr> | 190 </tr> |
| 195 <tr> | 191 <tr> |
| 196 <td><a href="#DocStyleChecker.__getSummaryLine">__getSummaryLine</a></td> | 192 <td><a href="#DocStyleChecker.__getSummaryLine">__getSummaryLine</a></td> |
| 197 <td>Private method to extract the summary line.</td> | 193 <td>Private method to extract the summary line.</td> |
| 198 </tr> | 194 </tr> |
| 249 <td>Private method to skip over an indented block of source code.</td> | 245 <td>Private method to skip over an indented block of source code.</td> |
| 250 </tr> | 246 </tr> |
| 251 <tr> | 247 <tr> |
| 252 <td><a href="#DocStyleChecker.run">run</a></td> | 248 <td><a href="#DocStyleChecker.run">run</a></td> |
| 253 <td>Public method to check the given source for violations of doc string conventions.</td> | 249 <td>Public method to check the given source for violations of doc string conventions.</td> |
| 254 </tr> | |
| 255 <tr> | |
| 256 <td><a href="#DocStyleChecker.unpackArgs">unpackArgs</a></td> | |
| 257 <td>Local helper function to unpack function argument names.</td> | |
| 258 </tr> | 250 </tr> |
| 259 </table> | 251 </table> |
| 260 <h3>Static Methods</h3> | 252 <h3>Static Methods</h3> |
| 261 | 253 |
| 262 <table> | 254 <table> |
| 803 <dt><i>context</i></dt> | 795 <dt><i>context</i></dt> |
| 804 <dd> | 796 <dd> |
| 805 context of the docstring (DocStyleContext) | 797 context of the docstring (DocStyleContext) |
| 806 </dd> | 798 </dd> |
| 807 </dl> | 799 </dl> |
| 808 <a NAME="DocStyleChecker.__checkUnicode" ID="DocStyleChecker.__checkUnicode"></a> | |
| 809 <h4>DocStyleChecker.__checkUnicode</h4> | |
| 810 <b>__checkUnicode</b>(<i>docstringContext, context</i>) | |
| 811 | |
| 812 <p> | |
| 813 Private method to check, that all docstrings containing unicode | |
| 814 characters are surrounded by unicode triple double quotes. | |
| 815 </p> | |
| 816 <dl> | |
| 817 | |
| 818 <dt><i>docstringContext</i></dt> | |
| 819 <dd> | |
| 820 docstring context (DocStyleContext) | |
| 821 </dd> | |
| 822 <dt><i>context</i></dt> | |
| 823 <dd> | |
| 824 context of the docstring (DocStyleContext) | |
| 825 </dd> | |
| 826 </dl> | |
| 827 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> | 800 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> |
| 828 <h4>DocStyleChecker.__error</h4> | 801 <h4>DocStyleChecker.__error</h4> |
| 829 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) | 802 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) |
| 830 | 803 |
| 831 <p> | 804 <p> |
| 852 </dl> | 825 </dl> |
| 853 <a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a> | 826 <a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a> |
| 854 <h4>DocStyleChecker.__getArgNames</h4> | 827 <h4>DocStyleChecker.__getArgNames</h4> |
| 855 <b>__getArgNames</b>(<i>node</i>) | 828 <b>__getArgNames</b>(<i>node</i>) |
| 856 | 829 |
| 830 <p> | |
| 831 Private method to get the argument names of a function node. | |
| 832 </p> | |
| 833 <dl> | |
| 834 | |
| 835 <dt><i>node</i></dt> | |
| 836 <dd> | |
| 837 AST node to extract arguments names from | |
| 838 </dd> | |
| 839 </dl> | |
| 840 <dl> | |
| 841 <dt>Returns:</dt> | |
| 842 <dd> | |
| 843 tuple of two list of argument names, one for arguments | |
| 844 and one for keyword arguments (tuple of list of string) | |
| 845 </dd> | |
| 846 </dl> | |
| 857 <a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a> | 847 <a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a> |
| 858 <h4>DocStyleChecker.__getSummaryLine</h4> | 848 <h4>DocStyleChecker.__getSummaryLine</h4> |
| 859 <b>__getSummaryLine</b>(<i>docstringContext</i>) | 849 <b>__getSummaryLine</b>(<i>docstringContext</i>) |
| 860 | 850 |
| 861 <p> | 851 <p> |
| 1091 | 1081 |
| 1092 <p> | 1082 <p> |
| 1093 Public method to check the given source for violations of doc string | 1083 Public method to check the given source for violations of doc string |
| 1094 conventions. | 1084 conventions. |
| 1095 </p> | 1085 </p> |
| 1096 <a NAME="DocStyleChecker.unpackArgs" ID="DocStyleChecker.unpackArgs"></a> | |
| 1097 <h4>DocStyleChecker.unpackArgs</h4> | |
| 1098 <b>unpackArgs</b>(<i></i>) | |
| 1099 | |
| 1100 <p> | |
| 1101 Local helper function to unpack function argument names. | |
| 1102 </p> | |
| 1103 <dl> | |
| 1104 | |
| 1105 <dt><i>args</i></dt> | |
| 1106 <dd> | |
| 1107 list of AST node arguments | |
| 1108 </dd> | |
| 1109 </dl> | |
| 1110 <dl> | |
| 1111 <dt>Returns:</dt> | |
| 1112 <dd> | |
| 1113 list of argument names (list of string) | |
| 1114 </dd> | |
| 1115 </dl> | |
| 1116 <div align="right"><a href="#top">Up</a></div> | 1086 <div align="right"><a href="#top">Up</a></div> |
| 1117 <hr /> | 1087 <hr /> |
| 1118 <hr /> | 1088 <hr /> |
| 1119 <a NAME="DocStyleContext" ID="DocStyleContext"></a> | 1089 <a NAME="DocStyleContext" ID="DocStyleContext"></a> |
| 1120 <h2>DocStyleContext</h2> | 1090 <h2>DocStyleContext</h2> |
