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 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7641
21ea4fd50b0a
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker</h1> 23 <h1>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker</h1>
24
23 <p> 25 <p>
24 Module implementing a checker for documentation string conventions. 26 Module implementing a checker for documentation string conventions.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#DocStyleChecker">DocStyleChecker</a></td> 38 <td><a href="#DocStyleChecker">DocStyleChecker</a></td>
34 <td>Class implementing a checker for documentation string conventions.</td> 39 <td>Class implementing a checker for documentation string conventions.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#DocStyleContext">DocStyleContext</a></td> 42 <td><a href="#DocStyleContext">DocStyleContext</a></td>
37 <td>Class implementing the source context.</td> 43 <td>Class implementing the source context.</td>
38 </tr> 44 </tr>
39 </table> 45 </table>
40 <h3>Functions</h3> 46 <h3>Functions</h3>
47
41 <table> 48 <table>
42 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
43 </table> 50 </table>
44 <hr /><hr /> 51 <hr />
52 <hr />
45 <a NAME="DocStyleChecker" ID="DocStyleChecker"></a> 53 <a NAME="DocStyleChecker" ID="DocStyleChecker"></a>
46 <h2>DocStyleChecker</h2> 54 <h2>DocStyleChecker</h2>
55
47 <p> 56 <p>
48 Class implementing a checker for documentation string conventions. 57 Class implementing a checker for documentation string conventions.
49 </p> 58 </p>
50 <h3>Derived from</h3> 59 <h3>Derived from</h3>
51 object 60 object
52 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
62
53 <table> 63 <table>
54 <tr><td>Codes</td></tr> 64 <tr><td>Codes</td></tr>
55 </table> 65 </table>
56 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Methods</h3> 71 <h3>Methods</h3>
72
61 <table> 73 <table>
74
62 <tr> 75 <tr>
63 <td><a href="#DocStyleChecker.__init__">DocStyleChecker</a></td> 76 <td><a href="#DocStyleChecker.__init__">DocStyleChecker</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#DocStyleChecker.__checkBackslashes">__checkBackslashes</a></td> 80 <td><a href="#DocStyleChecker.__checkBackslashes">__checkBackslashes</a></td>
67 <td>Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes.</td> 81 <td>Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#DocStyleChecker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td> 84 <td><a href="#DocStyleChecker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td>
70 <td>Private method to check, that the last paragraph of docstrings is followed by a blank line.</td> 85 <td>Private method to check, that the last paragraph of docstrings is followed by a blank line.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#DocStyleChecker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td> 88 <td><a href="#DocStyleChecker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td>
73 <td>Private method to check, that docstring summaries are followed by a blank line.</td> 89 <td>Private method to check, that docstring summaries are followed by a blank line.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#DocStyleChecker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td> 92 <td><a href="#DocStyleChecker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td>
76 <td>Private method to check, that class docstrings have one blank line around them.</td> 93 <td>Private method to check, that class docstrings have one blank line around them.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#DocStyleChecker.__checkClassDocstring">__checkClassDocstring</a></td> 96 <td><a href="#DocStyleChecker.__checkClassDocstring">__checkClassDocstring</a></td>
79 <td>Private method to check, that all public functions and methods have a docstring.</td> 97 <td>Private method to check, that all public functions and methods have a docstring.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#DocStyleChecker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td> 100 <td><a href="#DocStyleChecker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td>
82 <td>Private method to check, that docstring summaries end with a period.</td> 101 <td>Private method to check, that docstring summaries end with a period.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#DocStyleChecker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td> 104 <td><a href="#DocStyleChecker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td>
85 <td>Private method to check, that docstring summaries are followed by a blank line.</td> 105 <td>Private method to check, that docstring summaries are followed by a blank line.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> 108 <td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td>
88 <td>Private method to check, that docstring summaries end with a period.</td> 109 <td>Private method to check, that docstring summaries end with a period.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#DocStyleChecker.__checkEricException">__checkEricException</a></td> 112 <td><a href="#DocStyleChecker.__checkEricException">__checkEricException</a></td>
91 <td>Private method to check, that docstrings contain an &#64;exception line if they raise an exception and don't otherwise.</td> 113 <td>Private method to check, that docstrings contain an &#64;exception line if they raise an exception and don't otherwise.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#DocStyleChecker.__checkEricFunctionArguments">__checkEricFunctionArguments</a></td> 116 <td><a href="#DocStyleChecker.__checkEricFunctionArguments">__checkEricFunctionArguments</a></td>
94 <td>Private method to check, that docstrings contain an &#64;param and/or &#64;keyparam line for each argument.</td> 117 <td>Private method to check, that docstrings contain an &#64;param and/or &#64;keyparam line for each argument.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#DocStyleChecker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td> 120 <td><a href="#DocStyleChecker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td>
97 <td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td> 121 <td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> 124 <td><a href="#DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td>
100 <td>Private method to check, that class and function/method docstrings have no blank line around them.</td> 125 <td>Private method to check, that class and function/method docstrings have no blank line around them.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#DocStyleChecker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td> 128 <td><a href="#DocStyleChecker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td>
103 <td>Private method to check, that leading and trailing quotes are on a line by themselves.</td> 129 <td>Private method to check, that leading and trailing quotes are on a line by themselves.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td> 132 <td><a href="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td>
106 <td>Private method to check, that docstrings contain an &#64;return line if they return anything and don't otherwise.</td> 133 <td>Private method to check, that docstrings contain an &#64;return line if they return anything and don't otherwise.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#DocStyleChecker.__checkEricSignal">__checkEricSignal</a></td> 136 <td><a href="#DocStyleChecker.__checkEricSignal">__checkEricSignal</a></td>
109 <td>Private method to check, that docstrings contain an &#64;signal line if they define signals and don't otherwise.</td> 137 <td>Private method to check, that docstrings contain an &#64;signal line if they define signals and don't otherwise.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#DocStyleChecker.__checkEricSummary">__checkEricSummary</a></td> 140 <td><a href="#DocStyleChecker.__checkEricSummary">__checkEricSummary</a></td>
112 <td>Private method to check, that method docstring summaries start with specific words.</td> 141 <td>Private method to check, that method docstring summaries start with specific words.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> 144 <td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td>
115 <td>Private method to check, that all public functions and methods have a docstring.</td> 145 <td>Private method to check, that all public functions and methods have a docstring.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#DocStyleChecker.__checkImperativeMood">__checkImperativeMood</a></td> 148 <td><a href="#DocStyleChecker.__checkImperativeMood">__checkImperativeMood</a></td>
118 <td>Private method to check, that docstring summaries are in imperative mood.</td> 149 <td>Private method to check, that docstring summaries are in imperative mood.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#DocStyleChecker.__checkIndent">__checkIndent</a></td> 152 <td><a href="#DocStyleChecker.__checkIndent">__checkIndent</a></td>
121 <td>Private method to check, that docstrings are properly indented.</td> 153 <td>Private method to check, that docstrings are properly indented.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#DocStyleChecker.__checkModulesDocstrings">__checkModulesDocstrings</a></td> 156 <td><a href="#DocStyleChecker.__checkModulesDocstrings">__checkModulesDocstrings</a></td>
124 <td>Private method to check, if the module has a docstring.</td> 157 <td>Private method to check, if the module has a docstring.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#DocStyleChecker.__checkNoBlankLineBefore">__checkNoBlankLineBefore</a></td> 160 <td><a href="#DocStyleChecker.__checkNoBlankLineBefore">__checkNoBlankLineBefore</a></td>
127 <td>Private method to check, that function/method docstrings are not preceded by a blank line.</td> 161 <td>Private method to check, that function/method docstrings are not preceded by a blank line.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#DocStyleChecker.__checkNoSignature">__checkNoSignature</a></td> 164 <td><a href="#DocStyleChecker.__checkNoSignature">__checkNoSignature</a></td>
130 <td>Private method to check, that docstring summaries don't repeat the function's signature.</td> 165 <td>Private method to check, that docstring summaries don't repeat the function's signature.</td>
131 </tr><tr> 166 </tr>
167 <tr>
132 <td><a href="#DocStyleChecker.__checkOneLiner">__checkOneLiner</a></td> 168 <td><a href="#DocStyleChecker.__checkOneLiner">__checkOneLiner</a></td>
133 <td>Private method to check, that one-liner docstrings fit on one line with quotes.</td> 169 <td>Private method to check, that one-liner docstrings fit on one line with quotes.</td>
134 </tr><tr> 170 </tr>
171 <tr>
135 <td><a href="#DocStyleChecker.__checkReturnType">__checkReturnType</a></td> 172 <td><a href="#DocStyleChecker.__checkReturnType">__checkReturnType</a></td>
136 <td>Private method to check, that docstrings mention the return value type.</td> 173 <td>Private method to check, that docstrings mention the return value type.</td>
137 </tr><tr> 174 </tr>
175 <tr>
138 <td><a href="#DocStyleChecker.__checkSummary">__checkSummary</a></td> 176 <td><a href="#DocStyleChecker.__checkSummary">__checkSummary</a></td>
139 <td>Private method to check, that docstring summaries contain some text.</td> 177 <td>Private method to check, that docstring summaries contain some text.</td>
140 </tr><tr> 178 </tr>
179 <tr>
141 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> 180 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td>
142 <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>
143 </tr><tr> 182 </tr>
183 <tr>
144 <td><a href="#DocStyleChecker.__checkUnicode">__checkUnicode</a></td> 184 <td><a href="#DocStyleChecker.__checkUnicode">__checkUnicode</a></td>
145 <td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td> 185 <td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td>
146 </tr><tr> 186 </tr>
187 <tr>
147 <td><a href="#DocStyleChecker.__error">__error</a></td> 188 <td><a href="#DocStyleChecker.__error">__error</a></td>
148 <td>Private method to record an issue.</td> 189 <td>Private method to record an issue.</td>
149 </tr><tr> 190 </tr>
191 <tr>
150 <td><a href="#DocStyleChecker.__getArgNames">__getArgNames</a></td> 192 <td><a href="#DocStyleChecker.__getArgNames">__getArgNames</a></td>
151 <td></td> 193 <td></td>
152 </tr><tr> 194 </tr>
195 <tr>
153 <td><a href="#DocStyleChecker.__getSummaryLine">__getSummaryLine</a></td> 196 <td><a href="#DocStyleChecker.__getSummaryLine">__getSummaryLine</a></td>
154 <td>Private method to extract the summary line.</td> 197 <td>Private method to extract the summary line.</td>
155 </tr><tr> 198 </tr>
199 <tr>
156 <td><a href="#DocStyleChecker.__getSummaryLines">__getSummaryLines</a></td> 200 <td><a href="#DocStyleChecker.__getSummaryLines">__getSummaryLines</a></td>
157 <td>Private method to extract the summary lines.</td> 201 <td>Private method to extract the summary lines.</td>
158 </tr><tr> 202 </tr>
203 <tr>
159 <td><a href="#DocStyleChecker.__ignoreCode">__ignoreCode</a></td> 204 <td><a href="#DocStyleChecker.__ignoreCode">__ignoreCode</a></td>
160 <td>Private method to check if the error code should be ignored.</td> 205 <td>Private method to check if the error code should be ignored.</td>
161 </tr><tr> 206 </tr>
207 <tr>
162 <td><a href="#DocStyleChecker.__parseClasses">__parseClasses</a></td> 208 <td><a href="#DocStyleChecker.__parseClasses">__parseClasses</a></td>
163 <td>Private method to extract top-level classes.</td> 209 <td>Private method to extract top-level classes.</td>
164 </tr><tr> 210 </tr>
211 <tr>
165 <td><a href="#DocStyleChecker.__parseContexts">__parseContexts</a></td> 212 <td><a href="#DocStyleChecker.__parseContexts">__parseContexts</a></td>
166 <td>Private method to extract a context from the source.</td> 213 <td>Private method to extract a context from the source.</td>
167 </tr><tr> 214 </tr>
215 <tr>
168 <td><a href="#DocStyleChecker.__parseDocstring">__parseDocstring</a></td> 216 <td><a href="#DocStyleChecker.__parseDocstring">__parseDocstring</a></td>
169 <td>Private method to extract a docstring given `def` or `class` source.</td> 217 <td>Private method to extract a docstring given `def` or `class` source.</td>
170 </tr><tr> 218 </tr>
219 <tr>
171 <td><a href="#DocStyleChecker.__parseFunctions">__parseFunctions</a></td> 220 <td><a href="#DocStyleChecker.__parseFunctions">__parseFunctions</a></td>
172 <td>Private method to extract top-level functions.</td> 221 <td>Private method to extract top-level functions.</td>
173 </tr><tr> 222 </tr>
223 <tr>
174 <td><a href="#DocStyleChecker.__parseMethods">__parseMethods</a></td> 224 <td><a href="#DocStyleChecker.__parseMethods">__parseMethods</a></td>
175 <td>Private method to extract methods of all classes.</td> 225 <td>Private method to extract methods of all classes.</td>
176 </tr><tr> 226 </tr>
227 <tr>
177 <td><a href="#DocStyleChecker.__parseModuleDocstring">__parseModuleDocstring</a></td> 228 <td><a href="#DocStyleChecker.__parseModuleDocstring">__parseModuleDocstring</a></td>
178 <td>Private method to extract a docstring given a module source.</td> 229 <td>Private method to extract a docstring given a module source.</td>
179 </tr><tr> 230 </tr>
231 <tr>
180 <td><a href="#DocStyleChecker.__parseTopLevel">__parseTopLevel</a></td> 232 <td><a href="#DocStyleChecker.__parseTopLevel">__parseTopLevel</a></td>
181 <td>Private method to extract top-level functions or classes.</td> 233 <td>Private method to extract top-level functions or classes.</td>
182 </tr><tr> 234 </tr>
235 <tr>
183 <td><a href="#DocStyleChecker.__readline">__readline</a></td> 236 <td><a href="#DocStyleChecker.__readline">__readline</a></td>
184 <td>Private method to get the next line from the source.</td> 237 <td>Private method to get the next line from the source.</td>
185 </tr><tr> 238 </tr>
239 <tr>
186 <td><a href="#DocStyleChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td> 240 <td><a href="#DocStyleChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td>
187 <td>Private method to report a syntax error.</td> 241 <td>Private method to report a syntax error.</td>
188 </tr><tr> 242 </tr>
243 <tr>
189 <td><a href="#DocStyleChecker.__resetReadline">__resetReadline</a></td> 244 <td><a href="#DocStyleChecker.__resetReadline">__resetReadline</a></td>
190 <td>Private method to reset the internal readline function.</td> 245 <td>Private method to reset the internal readline function.</td>
191 </tr><tr> 246 </tr>
247 <tr>
192 <td><a href="#DocStyleChecker.__skipIndentedBlock">__skipIndentedBlock</a></td> 248 <td><a href="#DocStyleChecker.__skipIndentedBlock">__skipIndentedBlock</a></td>
193 <td>Private method to skip over an indented block of source code.</td> 249 <td>Private method to skip over an indented block of source code.</td>
194 </tr><tr> 250 </tr>
251 <tr>
195 <td><a href="#DocStyleChecker.run">run</a></td> 252 <td><a href="#DocStyleChecker.run">run</a></td>
196 <td>Public method to check the given source for violations of doc string conventions.</td> 253 <td>Public method to check the given source for violations of doc string conventions.</td>
197 </tr><tr> 254 </tr>
255 <tr>
198 <td><a href="#DocStyleChecker.unpackArgs">unpackArgs</a></td> 256 <td><a href="#DocStyleChecker.unpackArgs">unpackArgs</a></td>
199 <td>Local helper function to unpack function argument names.</td> 257 <td>Local helper function to unpack function argument names.</td>
200 </tr> 258 </tr>
201 </table> 259 </table>
202 <h3>Static Methods</h3> 260 <h3>Static Methods</h3>
261
203 <table> 262 <table>
204 <tr><td>None</td></tr> 263 <tr><td>None</td></tr>
205 </table> 264 </table>
265
206 <a NAME="DocStyleChecker.__init__" ID="DocStyleChecker.__init__"></a> 266 <a NAME="DocStyleChecker.__init__" ID="DocStyleChecker.__init__"></a>
207 <h4>DocStyleChecker (Constructor)</h4> 267 <h4>DocStyleChecker (Constructor)</h4>
208 <b>DocStyleChecker</b>(<i>source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257"</i>) 268 <b>DocStyleChecker</b>(<i>source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257"</i>)
269
209 <p> 270 <p>
210 Constructor 271 Constructor
211 </p><dl> 272 </p>
273 <dl>
274
212 <dt><i>source</i></dt> 275 <dt><i>source</i></dt>
213 <dd> 276 <dd>
214 source code to be checked (list of string) 277 source code to be checked (list of string)
215 </dd><dt><i>filename</i></dt> 278 </dd>
279 <dt><i>filename</i></dt>
216 <dd> 280 <dd>
217 name of the source file (string) 281 name of the source file (string)
218 </dd><dt><i>select</i></dt> 282 </dd>
283 <dt><i>select</i></dt>
219 <dd> 284 <dd>
220 list of selected codes (list of string) 285 list of selected codes (list of string)
221 </dd><dt><i>ignore</i></dt> 286 </dd>
287 <dt><i>ignore</i></dt>
222 <dd> 288 <dd>
223 list of codes to be ignored (list of string) 289 list of codes to be ignored (list of string)
224 </dd><dt><i>expected</i></dt> 290 </dd>
291 <dt><i>expected</i></dt>
225 <dd> 292 <dd>
226 list of expected codes (list of string) 293 list of expected codes (list of string)
227 </dd><dt><i>repeat</i></dt> 294 </dd>
295 <dt><i>repeat</i></dt>
228 <dd> 296 <dd>
229 flag indicating to report each occurrence of a code 297 flag indicating to report each occurrence of a code
230 (boolean) 298 (boolean)
231 </dd><dt><i>maxLineLength=</i></dt> 299 </dd>
300 <dt><i>maxLineLength=</i></dt>
232 <dd> 301 <dd>
233 allowed line length (integer) 302 allowed line length (integer)
234 </dd><dt><i>docType=</i></dt> 303 </dd>
304 <dt><i>docType=</i></dt>
235 <dd> 305 <dd>
236 type of the documentation strings 306 type of the documentation strings
237 (string, one of 'eric' or 'pep257') 307 (string, one of 'eric' or 'pep257')
238 </dd> 308 </dd>
239 </dl><a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a> 309 </dl>
310 <a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a>
240 <h4>DocStyleChecker.__checkBackslashes</h4> 311 <h4>DocStyleChecker.__checkBackslashes</h4>
241 <b>__checkBackslashes</b>(<i>docstringContext, context</i>) 312 <b>__checkBackslashes</b>(<i>docstringContext, context</i>)
313
242 <p> 314 <p>
243 Private method to check, that all docstrings containing 315 Private method to check, that all docstrings containing
244 backslashes are surrounded by raw triple double quotes. 316 backslashes are surrounded by raw triple double quotes.
245 </p><dl> 317 </p>
246 <dt><i>docstringContext</i></dt> 318 <dl>
247 <dd> 319
248 docstring context (DocStyleContext) 320 <dt><i>docstringContext</i></dt>
249 </dd><dt><i>context</i></dt> 321 <dd>
250 <dd> 322 docstring context (DocStyleContext)
251 context of the docstring (DocStyleContext) 323 </dd>
252 </dd> 324 <dt><i>context</i></dt>
253 </dl><a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a> 325 <dd>
326 context of the docstring (DocStyleContext)
327 </dd>
328 </dl>
329 <a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a>
254 <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4> 330 <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4>
255 <b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) 331 <b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>)
332
256 <p> 333 <p>
257 Private method to check, that the last paragraph of docstrings is 334 Private method to check, that the last paragraph of docstrings is
258 followed by a blank line. 335 followed by a blank line.
259 </p><dl> 336 </p>
260 <dt><i>docstringContext</i></dt> 337 <dl>
261 <dd> 338
262 docstring context (DocStyleContext) 339 <dt><i>docstringContext</i></dt>
263 </dd><dt><i>context</i></dt> 340 <dd>
264 <dd> 341 docstring context (DocStyleContext)
265 context of the docstring (DocStyleContext) 342 </dd>
266 </dd> 343 <dt><i>context</i></dt>
267 </dl><a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a> 344 <dd>
345 context of the docstring (DocStyleContext)
346 </dd>
347 </dl>
348 <a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a>
268 <h4>DocStyleChecker.__checkBlankAfterSummary</h4> 349 <h4>DocStyleChecker.__checkBlankAfterSummary</h4>
269 <b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>) 350 <b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>)
351
270 <p> 352 <p>
271 Private method to check, that docstring summaries are followed 353 Private method to check, that docstring summaries are followed
272 by a blank line. 354 by a blank line.
273 </p><dl> 355 </p>
274 <dt><i>docstringContext</i></dt> 356 <dl>
275 <dd> 357
276 docstring context (DocStyleContext) 358 <dt><i>docstringContext</i></dt>
277 </dd><dt><i>context</i></dt> 359 <dd>
278 <dd> 360 docstring context (DocStyleContext)
279 context of the docstring (DocStyleContext) 361 </dd>
280 </dd> 362 <dt><i>context</i></dt>
281 </dl><a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a> 363 <dd>
364 context of the docstring (DocStyleContext)
365 </dd>
366 </dl>
367 <a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a>
282 <h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4> 368 <h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4>
283 <b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) 369 <b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>)
370
284 <p> 371 <p>
285 Private method to check, that class docstrings have one 372 Private method to check, that class docstrings have one
286 blank line around them. 373 blank line around them.
287 </p><dl> 374 </p>
288 <dt><i>docstringContext</i></dt> 375 <dl>
289 <dd> 376
290 docstring context (DocStyleContext) 377 <dt><i>docstringContext</i></dt>
291 </dd><dt><i>context</i></dt> 378 <dd>
292 <dd> 379 docstring context (DocStyleContext)
293 context of the docstring (DocStyleContext) 380 </dd>
294 </dd> 381 <dt><i>context</i></dt>
295 </dl><a NAME="DocStyleChecker.__checkClassDocstring" ID="DocStyleChecker.__checkClassDocstring"></a> 382 <dd>
383 context of the docstring (DocStyleContext)
384 </dd>
385 </dl>
386 <a NAME="DocStyleChecker.__checkClassDocstring" ID="DocStyleChecker.__checkClassDocstring"></a>
296 <h4>DocStyleChecker.__checkClassDocstring</h4> 387 <h4>DocStyleChecker.__checkClassDocstring</h4>
297 <b>__checkClassDocstring</b>(<i>docstringContext, context</i>) 388 <b>__checkClassDocstring</b>(<i>docstringContext, context</i>)
389
298 <p> 390 <p>
299 Private method to check, that all public functions and methods 391 Private method to check, that all public functions and methods
300 have a docstring. 392 have a docstring.
301 </p><dl> 393 </p>
302 <dt><i>docstringContext</i></dt> 394 <dl>
303 <dd> 395
304 docstring context (DocStyleContext) 396 <dt><i>docstringContext</i></dt>
305 </dd><dt><i>context</i></dt> 397 <dd>
306 <dd> 398 docstring context (DocStyleContext)
307 context of the docstring (DocStyleContext) 399 </dd>
308 </dd> 400 <dt><i>context</i></dt>
309 </dl><a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a> 401 <dd>
402 context of the docstring (DocStyleContext)
403 </dd>
404 </dl>
405 <a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a>
310 <h4>DocStyleChecker.__checkEndsWithPeriod</h4> 406 <h4>DocStyleChecker.__checkEndsWithPeriod</h4>
311 <b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>) 407 <b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>)
408
312 <p> 409 <p>
313 Private method to check, that docstring summaries end with a period. 410 Private method to check, that docstring summaries end with a period.
314 </p><dl> 411 </p>
315 <dt><i>docstringContext</i></dt> 412 <dl>
316 <dd> 413
317 docstring context (DocStyleContext) 414 <dt><i>docstringContext</i></dt>
318 </dd><dt><i>context</i></dt> 415 <dd>
319 <dd> 416 docstring context (DocStyleContext)
320 context of the docstring (DocStyleContext) 417 </dd>
321 </dd> 418 <dt><i>context</i></dt>
322 </dl><a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a> 419 <dd>
420 context of the docstring (DocStyleContext)
421 </dd>
422 </dl>
423 <a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a>
323 <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4> 424 <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4>
324 <b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>) 425 <b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>)
426
325 <p> 427 <p>
326 Private method to check, that docstring summaries are followed 428 Private method to check, that docstring summaries are followed
327 by a blank line. 429 by a blank line.
328 </p><dl> 430 </p>
329 <dt><i>docstringContext</i></dt> 431 <dl>
330 <dd> 432
331 docstring context (DocStyleContext) 433 <dt><i>docstringContext</i></dt>
332 </dd><dt><i>context</i></dt> 434 <dd>
333 <dd> 435 docstring context (DocStyleContext)
334 context of the docstring (DocStyleContext) 436 </dd>
335 </dd> 437 <dt><i>context</i></dt>
336 </dl><a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a> 438 <dd>
439 context of the docstring (DocStyleContext)
440 </dd>
441 </dl>
442 <a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a>
337 <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4> 443 <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4>
338 <b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>) 444 <b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>)
445
339 <p> 446 <p>
340 Private method to check, that docstring summaries end with a period. 447 Private method to check, that docstring summaries end with a period.
341 </p><dl> 448 </p>
342 <dt><i>docstringContext</i></dt> 449 <dl>
343 <dd> 450
344 docstring context (DocStyleContext) 451 <dt><i>docstringContext</i></dt>
345 </dd><dt><i>context</i></dt> 452 <dd>
346 <dd> 453 docstring context (DocStyleContext)
347 context of the docstring (DocStyleContext) 454 </dd>
348 </dd> 455 <dt><i>context</i></dt>
349 </dl><a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a> 456 <dd>
457 context of the docstring (DocStyleContext)
458 </dd>
459 </dl>
460 <a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a>
350 <h4>DocStyleChecker.__checkEricException</h4> 461 <h4>DocStyleChecker.__checkEricException</h4>
351 <b>__checkEricException</b>(<i>docstringContext, context</i>) 462 <b>__checkEricException</b>(<i>docstringContext, context</i>)
463
352 <p> 464 <p>
353 Private method to check, that docstrings contain an &#64;exception line 465 Private method to check, that docstrings contain an &#64;exception line
354 if they raise an exception and don't otherwise. 466 if they raise an exception and don't otherwise.
355 </p><p> 467 </p>
468 <p>
356 Note: This method also checks the raised and documented exceptions for 469 Note: This method also checks the raised and documented exceptions for
357 completeness (i.e. raised exceptions that are not documented or 470 completeness (i.e. raised exceptions that are not documented or
358 documented exceptions that are not raised) 471 documented exceptions that are not raised)
359 </p><dl> 472 </p>
360 <dt><i>docstringContext</i></dt> 473 <dl>
361 <dd> 474
362 docstring context (DocStyleContext) 475 <dt><i>docstringContext</i></dt>
363 </dd><dt><i>context</i></dt> 476 <dd>
364 <dd> 477 docstring context (DocStyleContext)
365 context of the docstring (DocStyleContext) 478 </dd>
366 </dd> 479 <dt><i>context</i></dt>
367 </dl><a NAME="DocStyleChecker.__checkEricFunctionArguments" ID="DocStyleChecker.__checkEricFunctionArguments"></a> 480 <dd>
481 context of the docstring (DocStyleContext)
482 </dd>
483 </dl>
484 <a NAME="DocStyleChecker.__checkEricFunctionArguments" ID="DocStyleChecker.__checkEricFunctionArguments"></a>
368 <h4>DocStyleChecker.__checkEricFunctionArguments</h4> 485 <h4>DocStyleChecker.__checkEricFunctionArguments</h4>
369 <b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>) 486 <b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>)
487
370 <p> 488 <p>
371 Private method to check, that docstrings contain an &#64;param and/or 489 Private method to check, that docstrings contain an &#64;param and/or
372 &#64;keyparam line for each argument. 490 &#64;keyparam line for each argument.
373 </p><dl> 491 </p>
374 <dt><i>docstringContext</i></dt> 492 <dl>
375 <dd> 493
376 docstring context (DocStyleContext) 494 <dt><i>docstringContext</i></dt>
377 </dd><dt><i>context</i></dt> 495 <dd>
378 <dd> 496 docstring context (DocStyleContext)
379 context of the docstring (DocStyleContext) 497 </dd>
380 </dd> 498 <dt><i>context</i></dt>
381 </dl><a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a> 499 <dd>
500 context of the docstring (DocStyleContext)
501 </dd>
502 </dl>
503 <a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a>
382 <h4>DocStyleChecker.__checkEricNBlankAfterLastParagraph</h4> 504 <h4>DocStyleChecker.__checkEricNBlankAfterLastParagraph</h4>
383 <b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) 505 <b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, context</i>)
506
384 <p> 507 <p>
385 Private method to check, that the last paragraph of docstrings is 508 Private method to check, that the last paragraph of docstrings is
386 not followed by a blank line. 509 not followed by a blank line.
387 </p><dl> 510 </p>
388 <dt><i>docstringContext</i></dt> 511 <dl>
389 <dd> 512
390 docstring context (DocStyleContext) 513 <dt><i>docstringContext</i></dt>
391 </dd><dt><i>context</i></dt> 514 <dd>
392 <dd> 515 docstring context (DocStyleContext)
393 context of the docstring (DocStyleContext) 516 </dd>
394 </dd> 517 <dt><i>context</i></dt>
395 </dl><a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> 518 <dd>
519 context of the docstring (DocStyleContext)
520 </dd>
521 </dl>
522 <a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a>
396 <h4>DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4> 523 <h4>DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4>
397 <b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>) 524 <b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>)
525
398 <p> 526 <p>
399 Private method to check, that class and function/method docstrings 527 Private method to check, that class and function/method docstrings
400 have no blank line around them. 528 have no blank line around them.
401 </p><dl> 529 </p>
402 <dt><i>docstringContext</i></dt> 530 <dl>
403 <dd> 531
404 docstring context (DocStyleContext) 532 <dt><i>docstringContext</i></dt>
405 </dd><dt><i>context</i></dt> 533 <dd>
406 <dd> 534 docstring context (DocStyleContext)
407 context of the docstring (DocStyleContext) 535 </dd>
408 </dd> 536 <dt><i>context</i></dt>
409 </dl><a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a> 537 <dd>
538 context of the docstring (DocStyleContext)
539 </dd>
540 </dl>
541 <a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a>
410 <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4> 542 <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4>
411 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) 543 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>)
544
412 <p> 545 <p>
413 Private method to check, that leading and trailing quotes are on 546 Private method to check, that leading and trailing quotes are on
414 a line by themselves. 547 a line by themselves.
415 </p><dl> 548 </p>
416 <dt><i>docstringContext</i></dt> 549 <dl>
417 <dd> 550
418 docstring context (DocStyleContext) 551 <dt><i>docstringContext</i></dt>
419 </dd><dt><i>context</i></dt> 552 <dd>
420 <dd> 553 docstring context (DocStyleContext)
421 context of the docstring (DocStyleContext) 554 </dd>
422 </dd> 555 <dt><i>context</i></dt>
423 </dl><a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a> 556 <dd>
557 context of the docstring (DocStyleContext)
558 </dd>
559 </dl>
560 <a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a>
424 <h4>DocStyleChecker.__checkEricReturn</h4> 561 <h4>DocStyleChecker.__checkEricReturn</h4>
425 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) 562 <b>__checkEricReturn</b>(<i>docstringContext, context</i>)
563
426 <p> 564 <p>
427 Private method to check, that docstrings contain an &#64;return line 565 Private method to check, that docstrings contain an &#64;return line
428 if they return anything and don't otherwise. 566 if they return anything and don't otherwise.
429 </p><dl> 567 </p>
430 <dt><i>docstringContext</i></dt> 568 <dl>
431 <dd> 569
432 docstring context (DocStyleContext) 570 <dt><i>docstringContext</i></dt>
433 </dd><dt><i>context</i></dt> 571 <dd>
434 <dd> 572 docstring context (DocStyleContext)
435 context of the docstring (DocStyleContext) 573 </dd>
436 </dd> 574 <dt><i>context</i></dt>
437 </dl><a NAME="DocStyleChecker.__checkEricSignal" ID="DocStyleChecker.__checkEricSignal"></a> 575 <dd>
576 context of the docstring (DocStyleContext)
577 </dd>
578 </dl>
579 <a NAME="DocStyleChecker.__checkEricSignal" ID="DocStyleChecker.__checkEricSignal"></a>
438 <h4>DocStyleChecker.__checkEricSignal</h4> 580 <h4>DocStyleChecker.__checkEricSignal</h4>
439 <b>__checkEricSignal</b>(<i>docstringContext, context</i>) 581 <b>__checkEricSignal</b>(<i>docstringContext, context</i>)
582
440 <p> 583 <p>
441 Private method to check, that docstrings contain an &#64;signal line 584 Private method to check, that docstrings contain an &#64;signal line
442 if they define signals and don't otherwise. 585 if they define signals and don't otherwise.
443 </p><p> 586 </p>
587 <p>
444 Note: This method also checks the defined and documented signals for 588 Note: This method also checks the defined and documented signals for
445 completeness (i.e. defined signals that are not documented or 589 completeness (i.e. defined signals that are not documented or
446 documented signals that are not defined) 590 documented signals that are not defined)
447 </p><dl> 591 </p>
448 <dt><i>docstringContext</i></dt> 592 <dl>
449 <dd> 593
450 docstring context (DocStyleContext) 594 <dt><i>docstringContext</i></dt>
451 </dd><dt><i>context</i></dt> 595 <dd>
452 <dd> 596 docstring context (DocStyleContext)
453 context of the docstring (DocStyleContext) 597 </dd>
454 </dd> 598 <dt><i>context</i></dt>
455 </dl><a NAME="DocStyleChecker.__checkEricSummary" ID="DocStyleChecker.__checkEricSummary"></a> 599 <dd>
600 context of the docstring (DocStyleContext)
601 </dd>
602 </dl>
603 <a NAME="DocStyleChecker.__checkEricSummary" ID="DocStyleChecker.__checkEricSummary"></a>
456 <h4>DocStyleChecker.__checkEricSummary</h4> 604 <h4>DocStyleChecker.__checkEricSummary</h4>
457 <b>__checkEricSummary</b>(<i>docstringContext, context</i>) 605 <b>__checkEricSummary</b>(<i>docstringContext, context</i>)
606
458 <p> 607 <p>
459 Private method to check, that method docstring summaries start with 608 Private method to check, that method docstring summaries start with
460 specific words. 609 specific words.
461 </p><dl> 610 </p>
462 <dt><i>docstringContext</i></dt> 611 <dl>
463 <dd> 612
464 docstring context (DocStyleContext) 613 <dt><i>docstringContext</i></dt>
465 </dd><dt><i>context</i></dt> 614 <dd>
466 <dd> 615 docstring context (DocStyleContext)
467 context of the docstring (DocStyleContext) 616 </dd>
468 </dd> 617 <dt><i>context</i></dt>
469 </dl><a NAME="DocStyleChecker.__checkFunctionDocstring" ID="DocStyleChecker.__checkFunctionDocstring"></a> 618 <dd>
619 context of the docstring (DocStyleContext)
620 </dd>
621 </dl>
622 <a NAME="DocStyleChecker.__checkFunctionDocstring" ID="DocStyleChecker.__checkFunctionDocstring"></a>
470 <h4>DocStyleChecker.__checkFunctionDocstring</h4> 623 <h4>DocStyleChecker.__checkFunctionDocstring</h4>
471 <b>__checkFunctionDocstring</b>(<i>docstringContext, context</i>) 624 <b>__checkFunctionDocstring</b>(<i>docstringContext, context</i>)
625
472 <p> 626 <p>
473 Private method to check, that all public functions and methods 627 Private method to check, that all public functions and methods
474 have a docstring. 628 have a docstring.
475 </p><dl> 629 </p>
476 <dt><i>docstringContext</i></dt> 630 <dl>
477 <dd> 631
478 docstring context (DocStyleContext) 632 <dt><i>docstringContext</i></dt>
479 </dd><dt><i>context</i></dt> 633 <dd>
480 <dd> 634 docstring context (DocStyleContext)
481 context of the docstring (DocStyleContext) 635 </dd>
482 </dd> 636 <dt><i>context</i></dt>
483 </dl><a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a> 637 <dd>
638 context of the docstring (DocStyleContext)
639 </dd>
640 </dl>
641 <a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a>
484 <h4>DocStyleChecker.__checkImperativeMood</h4> 642 <h4>DocStyleChecker.__checkImperativeMood</h4>
485 <b>__checkImperativeMood</b>(<i>docstringContext, context</i>) 643 <b>__checkImperativeMood</b>(<i>docstringContext, context</i>)
644
486 <p> 645 <p>
487 Private method to check, that docstring summaries are in 646 Private method to check, that docstring summaries are in
488 imperative mood. 647 imperative mood.
489 </p><dl> 648 </p>
490 <dt><i>docstringContext</i></dt> 649 <dl>
491 <dd> 650
492 docstring context (DocStyleContext) 651 <dt><i>docstringContext</i></dt>
493 </dd><dt><i>context</i></dt> 652 <dd>
494 <dd> 653 docstring context (DocStyleContext)
495 context of the docstring (DocStyleContext) 654 </dd>
496 </dd> 655 <dt><i>context</i></dt>
497 </dl><a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a> 656 <dd>
657 context of the docstring (DocStyleContext)
658 </dd>
659 </dl>
660 <a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a>
498 <h4>DocStyleChecker.__checkIndent</h4> 661 <h4>DocStyleChecker.__checkIndent</h4>
499 <b>__checkIndent</b>(<i>docstringContext, context</i>) 662 <b>__checkIndent</b>(<i>docstringContext, context</i>)
663
500 <p> 664 <p>
501 Private method to check, that docstrings are properly indented. 665 Private method to check, that docstrings are properly indented.
502 </p><dl> 666 </p>
503 <dt><i>docstringContext</i></dt> 667 <dl>
504 <dd> 668
505 docstring context (DocStyleContext) 669 <dt><i>docstringContext</i></dt>
506 </dd><dt><i>context</i></dt> 670 <dd>
507 <dd> 671 docstring context (DocStyleContext)
508 context of the docstring (DocStyleContext) 672 </dd>
509 </dd> 673 <dt><i>context</i></dt>
510 </dl><a NAME="DocStyleChecker.__checkModulesDocstrings" ID="DocStyleChecker.__checkModulesDocstrings"></a> 674 <dd>
675 context of the docstring (DocStyleContext)
676 </dd>
677 </dl>
678 <a NAME="DocStyleChecker.__checkModulesDocstrings" ID="DocStyleChecker.__checkModulesDocstrings"></a>
511 <h4>DocStyleChecker.__checkModulesDocstrings</h4> 679 <h4>DocStyleChecker.__checkModulesDocstrings</h4>
512 <b>__checkModulesDocstrings</b>(<i>docstringContext, context</i>) 680 <b>__checkModulesDocstrings</b>(<i>docstringContext, context</i>)
681
513 <p> 682 <p>
514 Private method to check, if the module has a docstring. 683 Private method to check, if the module has a docstring.
515 </p><dl> 684 </p>
516 <dt><i>docstringContext</i></dt> 685 <dl>
517 <dd> 686
518 docstring context (DocStyleContext) 687 <dt><i>docstringContext</i></dt>
519 </dd><dt><i>context</i></dt> 688 <dd>
520 <dd> 689 docstring context (DocStyleContext)
521 context of the docstring (DocStyleContext) 690 </dd>
522 </dd> 691 <dt><i>context</i></dt>
523 </dl><a NAME="DocStyleChecker.__checkNoBlankLineBefore" ID="DocStyleChecker.__checkNoBlankLineBefore"></a> 692 <dd>
693 context of the docstring (DocStyleContext)
694 </dd>
695 </dl>
696 <a NAME="DocStyleChecker.__checkNoBlankLineBefore" ID="DocStyleChecker.__checkNoBlankLineBefore"></a>
524 <h4>DocStyleChecker.__checkNoBlankLineBefore</h4> 697 <h4>DocStyleChecker.__checkNoBlankLineBefore</h4>
525 <b>__checkNoBlankLineBefore</b>(<i>docstringContext, context</i>) 698 <b>__checkNoBlankLineBefore</b>(<i>docstringContext, context</i>)
699
526 <p> 700 <p>
527 Private method to check, that function/method docstrings are not 701 Private method to check, that function/method docstrings are not
528 preceded by a blank line. 702 preceded by a blank line.
529 </p><dl> 703 </p>
530 <dt><i>docstringContext</i></dt> 704 <dl>
531 <dd> 705
532 docstring context (DocStyleContext) 706 <dt><i>docstringContext</i></dt>
533 </dd><dt><i>context</i></dt> 707 <dd>
534 <dd> 708 docstring context (DocStyleContext)
535 context of the docstring (DocStyleContext) 709 </dd>
536 </dd> 710 <dt><i>context</i></dt>
537 </dl><a NAME="DocStyleChecker.__checkNoSignature" ID="DocStyleChecker.__checkNoSignature"></a> 711 <dd>
712 context of the docstring (DocStyleContext)
713 </dd>
714 </dl>
715 <a NAME="DocStyleChecker.__checkNoSignature" ID="DocStyleChecker.__checkNoSignature"></a>
538 <h4>DocStyleChecker.__checkNoSignature</h4> 716 <h4>DocStyleChecker.__checkNoSignature</h4>
539 <b>__checkNoSignature</b>(<i>docstringContext, context</i>) 717 <b>__checkNoSignature</b>(<i>docstringContext, context</i>)
718
540 <p> 719 <p>
541 Private method to check, that docstring summaries don't repeat 720 Private method to check, that docstring summaries don't repeat
542 the function's signature. 721 the function's signature.
543 </p><dl> 722 </p>
544 <dt><i>docstringContext</i></dt> 723 <dl>
545 <dd> 724
546 docstring context (DocStyleContext) 725 <dt><i>docstringContext</i></dt>
547 </dd><dt><i>context</i></dt> 726 <dd>
548 <dd> 727 docstring context (DocStyleContext)
549 context of the docstring (DocStyleContext) 728 </dd>
550 </dd> 729 <dt><i>context</i></dt>
551 </dl><a NAME="DocStyleChecker.__checkOneLiner" ID="DocStyleChecker.__checkOneLiner"></a> 730 <dd>
731 context of the docstring (DocStyleContext)
732 </dd>
733 </dl>
734 <a NAME="DocStyleChecker.__checkOneLiner" ID="DocStyleChecker.__checkOneLiner"></a>
552 <h4>DocStyleChecker.__checkOneLiner</h4> 735 <h4>DocStyleChecker.__checkOneLiner</h4>
553 <b>__checkOneLiner</b>(<i>docstringContext, context</i>) 736 <b>__checkOneLiner</b>(<i>docstringContext, context</i>)
737
554 <p> 738 <p>
555 Private method to check, that one-liner docstrings fit on 739 Private method to check, that one-liner docstrings fit on
556 one line with quotes. 740 one line with quotes.
557 </p><dl> 741 </p>
558 <dt><i>docstringContext</i></dt> 742 <dl>
559 <dd> 743
560 docstring context (DocStyleContext) 744 <dt><i>docstringContext</i></dt>
561 </dd><dt><i>context</i></dt> 745 <dd>
562 <dd> 746 docstring context (DocStyleContext)
563 context of the docstring (DocStyleContext) 747 </dd>
564 </dd> 748 <dt><i>context</i></dt>
565 </dl><a NAME="DocStyleChecker.__checkReturnType" ID="DocStyleChecker.__checkReturnType"></a> 749 <dd>
750 context of the docstring (DocStyleContext)
751 </dd>
752 </dl>
753 <a NAME="DocStyleChecker.__checkReturnType" ID="DocStyleChecker.__checkReturnType"></a>
566 <h4>DocStyleChecker.__checkReturnType</h4> 754 <h4>DocStyleChecker.__checkReturnType</h4>
567 <b>__checkReturnType</b>(<i>docstringContext, context</i>) 755 <b>__checkReturnType</b>(<i>docstringContext, context</i>)
756
568 <p> 757 <p>
569 Private method to check, that docstrings mention the return value type. 758 Private method to check, that docstrings mention the return value type.
570 </p><dl> 759 </p>
571 <dt><i>docstringContext</i></dt> 760 <dl>
572 <dd> 761
573 docstring context (DocStyleContext) 762 <dt><i>docstringContext</i></dt>
574 </dd><dt><i>context</i></dt> 763 <dd>
575 <dd> 764 docstring context (DocStyleContext)
576 context of the docstring (DocStyleContext) 765 </dd>
577 </dd> 766 <dt><i>context</i></dt>
578 </dl><a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a> 767 <dd>
768 context of the docstring (DocStyleContext)
769 </dd>
770 </dl>
771 <a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a>
579 <h4>DocStyleChecker.__checkSummary</h4> 772 <h4>DocStyleChecker.__checkSummary</h4>
580 <b>__checkSummary</b>(<i>docstringContext, context</i>) 773 <b>__checkSummary</b>(<i>docstringContext, context</i>)
774
581 <p> 775 <p>
582 Private method to check, that docstring summaries contain some text. 776 Private method to check, that docstring summaries contain some text.
583 </p><dl> 777 </p>
584 <dt><i>docstringContext</i></dt> 778 <dl>
585 <dd> 779
586 docstring context (DocStyleContext) 780 <dt><i>docstringContext</i></dt>
587 </dd><dt><i>context</i></dt> 781 <dd>
588 <dd> 782 docstring context (DocStyleContext)
589 context of the docstring (DocStyleContext) 783 </dd>
590 </dd> 784 <dt><i>context</i></dt>
591 </dl><a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a> 785 <dd>
786 context of the docstring (DocStyleContext)
787 </dd>
788 </dl>
789 <a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a>
592 <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4> 790 <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4>
593 <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>) 791 <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>)
792
594 <p> 793 <p>
595 Private method to check, that all docstrings are surrounded 794 Private method to check, that all docstrings are surrounded
596 by triple double quotes. 795 by triple double quotes.
597 </p><dl> 796 </p>
598 <dt><i>docstringContext</i></dt> 797 <dl>
599 <dd> 798
600 docstring context (DocStyleContext) 799 <dt><i>docstringContext</i></dt>
601 </dd><dt><i>context</i></dt> 800 <dd>
602 <dd> 801 docstring context (DocStyleContext)
603 context of the docstring (DocStyleContext) 802 </dd>
604 </dd> 803 <dt><i>context</i></dt>
605 </dl><a NAME="DocStyleChecker.__checkUnicode" ID="DocStyleChecker.__checkUnicode"></a> 804 <dd>
805 context of the docstring (DocStyleContext)
806 </dd>
807 </dl>
808 <a NAME="DocStyleChecker.__checkUnicode" ID="DocStyleChecker.__checkUnicode"></a>
606 <h4>DocStyleChecker.__checkUnicode</h4> 809 <h4>DocStyleChecker.__checkUnicode</h4>
607 <b>__checkUnicode</b>(<i>docstringContext, context</i>) 810 <b>__checkUnicode</b>(<i>docstringContext, context</i>)
811
608 <p> 812 <p>
609 Private method to check, that all docstrings containing unicode 813 Private method to check, that all docstrings containing unicode
610 characters are surrounded by unicode triple double quotes. 814 characters are surrounded by unicode triple double quotes.
611 </p><dl> 815 </p>
612 <dt><i>docstringContext</i></dt> 816 <dl>
613 <dd> 817
614 docstring context (DocStyleContext) 818 <dt><i>docstringContext</i></dt>
615 </dd><dt><i>context</i></dt> 819 <dd>
616 <dd> 820 docstring context (DocStyleContext)
617 context of the docstring (DocStyleContext) 821 </dd>
618 </dd> 822 <dt><i>context</i></dt>
619 </dl><a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> 823 <dd>
824 context of the docstring (DocStyleContext)
825 </dd>
826 </dl>
827 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a>
620 <h4>DocStyleChecker.__error</h4> 828 <h4>DocStyleChecker.__error</h4>
621 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) 829 <b>__error</b>(<i>lineNumber, offset, code, *args</i>)
830
622 <p> 831 <p>
623 Private method to record an issue. 832 Private method to record an issue.
624 </p><dl> 833 </p>
834 <dl>
835
625 <dt><i>lineNumber</i></dt> 836 <dt><i>lineNumber</i></dt>
626 <dd> 837 <dd>
627 line number of the issue (integer) 838 line number of the issue (integer)
628 </dd><dt><i>offset</i></dt> 839 </dd>
840 <dt><i>offset</i></dt>
629 <dd> 841 <dd>
630 position within line of the issue (integer) 842 position within line of the issue (integer)
631 </dd><dt><i>code</i></dt> 843 </dd>
844 <dt><i>code</i></dt>
632 <dd> 845 <dd>
633 message code (string) 846 message code (string)
634 </dd><dt><i>args</i></dt> 847 </dd>
848 <dt><i>args</i></dt>
635 <dd> 849 <dd>
636 arguments for the message (list) 850 arguments for the message (list)
637 </dd> 851 </dd>
638 </dl><a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a> 852 </dl>
853 <a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a>
639 <h4>DocStyleChecker.__getArgNames</h4> 854 <h4>DocStyleChecker.__getArgNames</h4>
640 <b>__getArgNames</b>(<i>node</i>) 855 <b>__getArgNames</b>(<i>node</i>)
856
641 <a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a> 857 <a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a>
642 <h4>DocStyleChecker.__getSummaryLine</h4> 858 <h4>DocStyleChecker.__getSummaryLine</h4>
643 <b>__getSummaryLine</b>(<i>docstringContext</i>) 859 <b>__getSummaryLine</b>(<i>docstringContext</i>)
860
644 <p> 861 <p>
645 Private method to extract the summary line. 862 Private method to extract the summary line.
646 </p><dl> 863 </p>
647 <dt><i>docstringContext</i></dt> 864 <dl>
648 <dd> 865
649 docstring context (DocStyleContext) 866 <dt><i>docstringContext</i></dt>
650 </dd> 867 <dd>
651 </dl><dl> 868 docstring context (DocStyleContext)
869 </dd>
870 </dl>
871 <dl>
652 <dt>Returns:</dt> 872 <dt>Returns:</dt>
653 <dd> 873 <dd>
654 summary line (string) and the line it was found on (integer) 874 summary line (string) and the line it was found on (integer)
655 </dd> 875 </dd>
656 </dl><a NAME="DocStyleChecker.__getSummaryLines" ID="DocStyleChecker.__getSummaryLines"></a> 876 </dl>
877 <a NAME="DocStyleChecker.__getSummaryLines" ID="DocStyleChecker.__getSummaryLines"></a>
657 <h4>DocStyleChecker.__getSummaryLines</h4> 878 <h4>DocStyleChecker.__getSummaryLines</h4>
658 <b>__getSummaryLines</b>(<i>docstringContext</i>) 879 <b>__getSummaryLines</b>(<i>docstringContext</i>)
880
659 <p> 881 <p>
660 Private method to extract the summary lines. 882 Private method to extract the summary lines.
661 </p><dl> 883 </p>
662 <dt><i>docstringContext</i></dt> 884 <dl>
663 <dd> 885
664 docstring context (DocStyleContext) 886 <dt><i>docstringContext</i></dt>
665 </dd> 887 <dd>
666 </dl><dl> 888 docstring context (DocStyleContext)
889 </dd>
890 </dl>
891 <dl>
667 <dt>Returns:</dt> 892 <dt>Returns:</dt>
668 <dd> 893 <dd>
669 summary lines (list of string) and the line it was found on 894 summary lines (list of string) and the line it was found on
670 (integer) 895 (integer)
671 </dd> 896 </dd>
672 </dl><a NAME="DocStyleChecker.__ignoreCode" ID="DocStyleChecker.__ignoreCode"></a> 897 </dl>
898 <a NAME="DocStyleChecker.__ignoreCode" ID="DocStyleChecker.__ignoreCode"></a>
673 <h4>DocStyleChecker.__ignoreCode</h4> 899 <h4>DocStyleChecker.__ignoreCode</h4>
674 <b>__ignoreCode</b>(<i>code</i>) 900 <b>__ignoreCode</b>(<i>code</i>)
901
675 <p> 902 <p>
676 Private method to check if the error code should be ignored. 903 Private method to check if the error code should be ignored.
677 </p><dl> 904 </p>
905 <dl>
906
678 <dt><i>code</i></dt> 907 <dt><i>code</i></dt>
679 <dd> 908 <dd>
680 message code to check for (string) 909 message code to check for (string)
681 </dd> 910 </dd>
682 </dl><dl> 911 </dl>
912 <dl>
683 <dt>Returns:</dt> 913 <dt>Returns:</dt>
684 <dd> 914 <dd>
685 flag indicating to ignore the given code (boolean) 915 flag indicating to ignore the given code (boolean)
686 </dd> 916 </dd>
687 </dl><a NAME="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a> 917 </dl>
918 <a NAME="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a>
688 <h4>DocStyleChecker.__parseClasses</h4> 919 <h4>DocStyleChecker.__parseClasses</h4>
689 <b>__parseClasses</b>(<i></i>) 920 <b>__parseClasses</b>(<i></i>)
921
690 <p> 922 <p>
691 Private method to extract top-level classes. 923 Private method to extract top-level classes.
692 </p><dl> 924 </p>
925 <dl>
693 <dt>Returns:</dt> 926 <dt>Returns:</dt>
694 <dd> 927 <dd>
695 extracted class contexts (list of DocStyleContext) 928 extracted class contexts (list of DocStyleContext)
696 </dd> 929 </dd>
697 </dl><a NAME="DocStyleChecker.__parseContexts" ID="DocStyleChecker.__parseContexts"></a> 930 </dl>
931 <a NAME="DocStyleChecker.__parseContexts" ID="DocStyleChecker.__parseContexts"></a>
698 <h4>DocStyleChecker.__parseContexts</h4> 932 <h4>DocStyleChecker.__parseContexts</h4>
699 <b>__parseContexts</b>(<i>kind</i>) 933 <b>__parseContexts</b>(<i>kind</i>)
934
700 <p> 935 <p>
701 Private method to extract a context from the source. 936 Private method to extract a context from the source.
702 </p><dl> 937 </p>
938 <dl>
939
703 <dt><i>kind</i></dt> 940 <dt><i>kind</i></dt>
704 <dd> 941 <dd>
705 kind of context to extract (string) 942 kind of context to extract (string)
706 </dd> 943 </dd>
707 </dl><dl> 944 </dl>
945 <dl>
708 <dt>Returns:</dt> 946 <dt>Returns:</dt>
709 <dd> 947 <dd>
710 requested contexts (list of DocStyleContext) 948 requested contexts (list of DocStyleContext)
711 </dd> 949 </dd>
712 </dl><a NAME="DocStyleChecker.__parseDocstring" ID="DocStyleChecker.__parseDocstring"></a> 950 </dl>
951 <a NAME="DocStyleChecker.__parseDocstring" ID="DocStyleChecker.__parseDocstring"></a>
713 <h4>DocStyleChecker.__parseDocstring</h4> 952 <h4>DocStyleChecker.__parseDocstring</h4>
714 <b>__parseDocstring</b>(<i>context, what=''</i>) 953 <b>__parseDocstring</b>(<i>context, what=''</i>)
954
715 <p> 955 <p>
716 Private method to extract a docstring given `def` or `class` source. 956 Private method to extract a docstring given `def` or `class` source.
717 </p><dl> 957 </p>
958 <dl>
959
718 <dt><i>context</i></dt> 960 <dt><i>context</i></dt>
719 <dd> 961 <dd>
720 context data to get the docstring from (DocStyleContext) 962 context data to get the docstring from (DocStyleContext)
721 </dd><dt><i>what</i></dt> 963 </dd>
964 <dt><i>what</i></dt>
722 <dd> 965 <dd>
723 string denoting what is being parsed (string) 966 string denoting what is being parsed (string)
724 </dd> 967 </dd>
725 </dl><dl> 968 </dl>
969 <dl>
726 <dt>Returns:</dt> 970 <dt>Returns:</dt>
727 <dd> 971 <dd>
728 context of extracted docstring (DocStyleContext) 972 context of extracted docstring (DocStyleContext)
729 </dd> 973 </dd>
730 </dl><a NAME="DocStyleChecker.__parseFunctions" ID="DocStyleChecker.__parseFunctions"></a> 974 </dl>
975 <a NAME="DocStyleChecker.__parseFunctions" ID="DocStyleChecker.__parseFunctions"></a>
731 <h4>DocStyleChecker.__parseFunctions</h4> 976 <h4>DocStyleChecker.__parseFunctions</h4>
732 <b>__parseFunctions</b>(<i></i>) 977 <b>__parseFunctions</b>(<i></i>)
978
733 <p> 979 <p>
734 Private method to extract top-level functions. 980 Private method to extract top-level functions.
735 </p><dl> 981 </p>
982 <dl>
736 <dt>Returns:</dt> 983 <dt>Returns:</dt>
737 <dd> 984 <dd>
738 extracted function contexts (list of DocStyleContext) 985 extracted function contexts (list of DocStyleContext)
739 </dd> 986 </dd>
740 </dl><a NAME="DocStyleChecker.__parseMethods" ID="DocStyleChecker.__parseMethods"></a> 987 </dl>
988 <a NAME="DocStyleChecker.__parseMethods" ID="DocStyleChecker.__parseMethods"></a>
741 <h4>DocStyleChecker.__parseMethods</h4> 989 <h4>DocStyleChecker.__parseMethods</h4>
742 <b>__parseMethods</b>(<i></i>) 990 <b>__parseMethods</b>(<i></i>)
991
743 <p> 992 <p>
744 Private method to extract methods of all classes. 993 Private method to extract methods of all classes.
745 </p><dl> 994 </p>
995 <dl>
746 <dt>Returns:</dt> 996 <dt>Returns:</dt>
747 <dd> 997 <dd>
748 extracted method contexts (list of DocStyleContext) 998 extracted method contexts (list of DocStyleContext)
749 </dd> 999 </dd>
750 </dl><a NAME="DocStyleChecker.__parseModuleDocstring" ID="DocStyleChecker.__parseModuleDocstring"></a> 1000 </dl>
1001 <a NAME="DocStyleChecker.__parseModuleDocstring" ID="DocStyleChecker.__parseModuleDocstring"></a>
751 <h4>DocStyleChecker.__parseModuleDocstring</h4> 1002 <h4>DocStyleChecker.__parseModuleDocstring</h4>
752 <b>__parseModuleDocstring</b>(<i>source</i>) 1003 <b>__parseModuleDocstring</b>(<i>source</i>)
1004
753 <p> 1005 <p>
754 Private method to extract a docstring given a module source. 1006 Private method to extract a docstring given a module source.
755 </p><dl> 1007 </p>
1008 <dl>
1009
756 <dt><i>source</i></dt> 1010 <dt><i>source</i></dt>
757 <dd> 1011 <dd>
758 source to parse (list of string) 1012 source to parse (list of string)
759 </dd> 1013 </dd>
760 </dl><dl> 1014 </dl>
1015 <dl>
761 <dt>Returns:</dt> 1016 <dt>Returns:</dt>
762 <dd> 1017 <dd>
763 context of extracted docstring (DocStyleContext) 1018 context of extracted docstring (DocStyleContext)
764 </dd> 1019 </dd>
765 </dl><a NAME="DocStyleChecker.__parseTopLevel" ID="DocStyleChecker.__parseTopLevel"></a> 1020 </dl>
1021 <a NAME="DocStyleChecker.__parseTopLevel" ID="DocStyleChecker.__parseTopLevel"></a>
766 <h4>DocStyleChecker.__parseTopLevel</h4> 1022 <h4>DocStyleChecker.__parseTopLevel</h4>
767 <b>__parseTopLevel</b>(<i>keyword</i>) 1023 <b>__parseTopLevel</b>(<i>keyword</i>)
1024
768 <p> 1025 <p>
769 Private method to extract top-level functions or classes. 1026 Private method to extract top-level functions or classes.
770 </p><dl> 1027 </p>
1028 <dl>
1029
771 <dt><i>keyword</i></dt> 1030 <dt><i>keyword</i></dt>
772 <dd> 1031 <dd>
773 keyword signaling what to extract (string) 1032 keyword signaling what to extract (string)
774 </dd> 1033 </dd>
775 </dl><dl> 1034 </dl>
1035 <dl>
776 <dt>Returns:</dt> 1036 <dt>Returns:</dt>
777 <dd> 1037 <dd>
778 extracted function or class contexts (list of DocStyleContext) 1038 extracted function or class contexts (list of DocStyleContext)
779 </dd> 1039 </dd>
780 </dl><a NAME="DocStyleChecker.__readline" ID="DocStyleChecker.__readline"></a> 1040 </dl>
1041 <a NAME="DocStyleChecker.__readline" ID="DocStyleChecker.__readline"></a>
781 <h4>DocStyleChecker.__readline</h4> 1042 <h4>DocStyleChecker.__readline</h4>
782 <b>__readline</b>(<i></i>) 1043 <b>__readline</b>(<i></i>)
1044
783 <p> 1045 <p>
784 Private method to get the next line from the source. 1046 Private method to get the next line from the source.
785 </p><dl> 1047 </p>
1048 <dl>
786 <dt>Returns:</dt> 1049 <dt>Returns:</dt>
787 <dd> 1050 <dd>
788 next line of source (string) 1051 next line of source (string)
789 </dd> 1052 </dd>
790 </dl><a NAME="DocStyleChecker.__reportInvalidSyntax" ID="DocStyleChecker.__reportInvalidSyntax"></a> 1053 </dl>
1054 <a NAME="DocStyleChecker.__reportInvalidSyntax" ID="DocStyleChecker.__reportInvalidSyntax"></a>
791 <h4>DocStyleChecker.__reportInvalidSyntax</h4> 1055 <h4>DocStyleChecker.__reportInvalidSyntax</h4>
792 <b>__reportInvalidSyntax</b>(<i></i>) 1056 <b>__reportInvalidSyntax</b>(<i></i>)
1057
793 <p> 1058 <p>
794 Private method to report a syntax error. 1059 Private method to report a syntax error.
795 </p><a NAME="DocStyleChecker.__resetReadline" ID="DocStyleChecker.__resetReadline"></a> 1060 </p>
1061 <a NAME="DocStyleChecker.__resetReadline" ID="DocStyleChecker.__resetReadline"></a>
796 <h4>DocStyleChecker.__resetReadline</h4> 1062 <h4>DocStyleChecker.__resetReadline</h4>
797 <b>__resetReadline</b>(<i></i>) 1063 <b>__resetReadline</b>(<i></i>)
1064
798 <p> 1065 <p>
799 Private method to reset the internal readline function. 1066 Private method to reset the internal readline function.
800 </p><a NAME="DocStyleChecker.__skipIndentedBlock" ID="DocStyleChecker.__skipIndentedBlock"></a> 1067 </p>
1068 <a NAME="DocStyleChecker.__skipIndentedBlock" ID="DocStyleChecker.__skipIndentedBlock"></a>
801 <h4>DocStyleChecker.__skipIndentedBlock</h4> 1069 <h4>DocStyleChecker.__skipIndentedBlock</h4>
802 <b>__skipIndentedBlock</b>(<i>tokenGenerator</i>) 1070 <b>__skipIndentedBlock</b>(<i>tokenGenerator</i>)
1071
803 <p> 1072 <p>
804 Private method to skip over an indented block of source code. 1073 Private method to skip over an indented block of source code.
805 </p><dl> 1074 </p>
1075 <dl>
1076
806 <dt><i>tokenGenerator</i></dt> 1077 <dt><i>tokenGenerator</i></dt>
807 <dd> 1078 <dd>
808 token generator 1079 token generator
809 </dd> 1080 </dd>
810 </dl><dl> 1081 </dl>
1082 <dl>
811 <dt>Returns:</dt> 1083 <dt>Returns:</dt>
812 <dd> 1084 <dd>
813 last token of the indented block 1085 last token of the indented block
814 </dd> 1086 </dd>
815 </dl><a NAME="DocStyleChecker.run" ID="DocStyleChecker.run"></a> 1087 </dl>
1088 <a NAME="DocStyleChecker.run" ID="DocStyleChecker.run"></a>
816 <h4>DocStyleChecker.run</h4> 1089 <h4>DocStyleChecker.run</h4>
817 <b>run</b>(<i></i>) 1090 <b>run</b>(<i></i>)
1091
818 <p> 1092 <p>
819 Public method to check the given source for violations of doc string 1093 Public method to check the given source for violations of doc string
820 conventions. 1094 conventions.
821 </p><a NAME="DocStyleChecker.unpackArgs" ID="DocStyleChecker.unpackArgs"></a> 1095 </p>
1096 <a NAME="DocStyleChecker.unpackArgs" ID="DocStyleChecker.unpackArgs"></a>
822 <h4>DocStyleChecker.unpackArgs</h4> 1097 <h4>DocStyleChecker.unpackArgs</h4>
823 <b>unpackArgs</b>(<i></i>) 1098 <b>unpackArgs</b>(<i></i>)
1099
824 <p> 1100 <p>
825 Local helper function to unpack function argument names. 1101 Local helper function to unpack function argument names.
826 </p><dl> 1102 </p>
1103 <dl>
1104
827 <dt><i>args</i></dt> 1105 <dt><i>args</i></dt>
828 <dd> 1106 <dd>
829 list of AST node arguments 1107 list of AST node arguments
830 </dd> 1108 </dd>
831 </dl><dl> 1109 </dl>
1110 <dl>
832 <dt>Returns:</dt> 1111 <dt>Returns:</dt>
833 <dd> 1112 <dd>
834 list of argument names (list of string) 1113 list of argument names (list of string)
835 </dd> 1114 </dd>
836 </dl> 1115 </dl>
837 <div align="right"><a href="#top">Up</a></div> 1116 <div align="right"><a href="#top">Up</a></div>
838 <hr /><hr /> 1117 <hr />
1118 <hr />
839 <a NAME="DocStyleContext" ID="DocStyleContext"></a> 1119 <a NAME="DocStyleContext" ID="DocStyleContext"></a>
840 <h2>DocStyleContext</h2> 1120 <h2>DocStyleContext</h2>
1121
841 <p> 1122 <p>
842 Class implementing the source context. 1123 Class implementing the source context.
843 </p> 1124 </p>
844 <h3>Derived from</h3> 1125 <h3>Derived from</h3>
845 object 1126 object
846 <h3>Class Attributes</h3> 1127 <h3>Class Attributes</h3>
1128
847 <table> 1129 <table>
848 <tr><td>None</td></tr> 1130 <tr><td>None</td></tr>
849 </table> 1131 </table>
850 <h3>Class Methods</h3> 1132 <h3>Class Methods</h3>
1133
851 <table> 1134 <table>
852 <tr><td>None</td></tr> 1135 <tr><td>None</td></tr>
853 </table> 1136 </table>
854 <h3>Methods</h3> 1137 <h3>Methods</h3>
1138
855 <table> 1139 <table>
1140
856 <tr> 1141 <tr>
857 <td><a href="#DocStyleContext.__init__">DocStyleContext</a></td> 1142 <td><a href="#DocStyleContext.__init__">DocStyleContext</a></td>
858 <td>Constructor</td> 1143 <td>Constructor</td>
859 </tr><tr> 1144 </tr>
1145 <tr>
860 <td><a href="#DocStyleContext.contextType">contextType</a></td> 1146 <td><a href="#DocStyleContext.contextType">contextType</a></td>
861 <td>Public method to get the context type.</td> 1147 <td>Public method to get the context type.</td>
862 </tr><tr> 1148 </tr>
1149 <tr>
863 <td><a href="#DocStyleContext.end">end</a></td> 1150 <td><a href="#DocStyleContext.end">end</a></td>
864 <td>Public method to get the end line number.</td> 1151 <td>Public method to get the end line number.</td>
865 </tr><tr> 1152 </tr>
1153 <tr>
866 <td><a href="#DocStyleContext.indent">indent</a></td> 1154 <td><a href="#DocStyleContext.indent">indent</a></td>
867 <td>Public method to get the indentation of the first line.</td> 1155 <td>Public method to get the indentation of the first line.</td>
868 </tr><tr> 1156 </tr>
1157 <tr>
869 <td><a href="#DocStyleContext.setSpecial">setSpecial</a></td> 1158 <td><a href="#DocStyleContext.setSpecial">setSpecial</a></td>
870 <td>Public method to set a special attribute for the context.</td> 1159 <td>Public method to set a special attribute for the context.</td>
871 </tr><tr> 1160 </tr>
1161 <tr>
872 <td><a href="#DocStyleContext.source">source</a></td> 1162 <td><a href="#DocStyleContext.source">source</a></td>
873 <td>Public method to get the source.</td> 1163 <td>Public method to get the source.</td>
874 </tr><tr> 1164 </tr>
1165 <tr>
875 <td><a href="#DocStyleContext.special">special</a></td> 1166 <td><a href="#DocStyleContext.special">special</a></td>
876 <td>Public method to get the special context attribute string.</td> 1167 <td>Public method to get the special context attribute string.</td>
877 </tr><tr> 1168 </tr>
1169 <tr>
878 <td><a href="#DocStyleContext.ssource">ssource</a></td> 1170 <td><a href="#DocStyleContext.ssource">ssource</a></td>
879 <td>Public method to get the joined source lines.</td> 1171 <td>Public method to get the joined source lines.</td>
880 </tr><tr> 1172 </tr>
1173 <tr>
881 <td><a href="#DocStyleContext.start">start</a></td> 1174 <td><a href="#DocStyleContext.start">start</a></td>
882 <td>Public method to get the start line number.</td> 1175 <td>Public method to get the start line number.</td>
883 </tr> 1176 </tr>
884 </table> 1177 </table>
885 <h3>Static Methods</h3> 1178 <h3>Static Methods</h3>
1179
886 <table> 1180 <table>
887 <tr><td>None</td></tr> 1181 <tr><td>None</td></tr>
888 </table> 1182 </table>
1183
889 <a NAME="DocStyleContext.__init__" ID="DocStyleContext.__init__"></a> 1184 <a NAME="DocStyleContext.__init__" ID="DocStyleContext.__init__"></a>
890 <h4>DocStyleContext (Constructor)</h4> 1185 <h4>DocStyleContext (Constructor)</h4>
891 <b>DocStyleContext</b>(<i>source, startLine, contextType</i>) 1186 <b>DocStyleContext</b>(<i>source, startLine, contextType</i>)
1187
892 <p> 1188 <p>
893 Constructor 1189 Constructor
894 </p><dl> 1190 </p>
1191 <dl>
1192
895 <dt><i>source</i></dt> 1193 <dt><i>source</i></dt>
896 <dd> 1194 <dd>
897 source code of the context (list of string or string) 1195 source code of the context (list of string or string)
898 </dd><dt><i>startLine</i></dt> 1196 </dd>
1197 <dt><i>startLine</i></dt>
899 <dd> 1198 <dd>
900 line number the context starts in the source (integer) 1199 line number the context starts in the source (integer)
901 </dd><dt><i>contextType</i></dt> 1200 </dd>
1201 <dt><i>contextType</i></dt>
902 <dd> 1202 <dd>
903 type of the context object (string) 1203 type of the context object (string)
904 </dd> 1204 </dd>
905 </dl><a NAME="DocStyleContext.contextType" ID="DocStyleContext.contextType"></a> 1205 </dl>
1206 <a NAME="DocStyleContext.contextType" ID="DocStyleContext.contextType"></a>
906 <h4>DocStyleContext.contextType</h4> 1207 <h4>DocStyleContext.contextType</h4>
907 <b>contextType</b>(<i></i>) 1208 <b>contextType</b>(<i></i>)
1209
908 <p> 1210 <p>
909 Public method to get the context type. 1211 Public method to get the context type.
910 </p><dl> 1212 </p>
1213 <dl>
911 <dt>Returns:</dt> 1214 <dt>Returns:</dt>
912 <dd> 1215 <dd>
913 context type (string) 1216 context type (string)
914 </dd> 1217 </dd>
915 </dl><a NAME="DocStyleContext.end" ID="DocStyleContext.end"></a> 1218 </dl>
1219 <a NAME="DocStyleContext.end" ID="DocStyleContext.end"></a>
916 <h4>DocStyleContext.end</h4> 1220 <h4>DocStyleContext.end</h4>
917 <b>end</b>(<i></i>) 1221 <b>end</b>(<i></i>)
1222
918 <p> 1223 <p>
919 Public method to get the end line number. 1224 Public method to get the end line number.
920 </p><dl> 1225 </p>
1226 <dl>
921 <dt>Returns:</dt> 1227 <dt>Returns:</dt>
922 <dd> 1228 <dd>
923 end line number (integer) 1229 end line number (integer)
924 </dd> 1230 </dd>
925 </dl><a NAME="DocStyleContext.indent" ID="DocStyleContext.indent"></a> 1231 </dl>
1232 <a NAME="DocStyleContext.indent" ID="DocStyleContext.indent"></a>
926 <h4>DocStyleContext.indent</h4> 1233 <h4>DocStyleContext.indent</h4>
927 <b>indent</b>(<i></i>) 1234 <b>indent</b>(<i></i>)
1235
928 <p> 1236 <p>
929 Public method to get the indentation of the first line. 1237 Public method to get the indentation of the first line.
930 </p><dl> 1238 </p>
1239 <dl>
931 <dt>Returns:</dt> 1240 <dt>Returns:</dt>
932 <dd> 1241 <dd>
933 indentation string (string) 1242 indentation string (string)
934 </dd> 1243 </dd>
935 </dl><a NAME="DocStyleContext.setSpecial" ID="DocStyleContext.setSpecial"></a> 1244 </dl>
1245 <a NAME="DocStyleContext.setSpecial" ID="DocStyleContext.setSpecial"></a>
936 <h4>DocStyleContext.setSpecial</h4> 1246 <h4>DocStyleContext.setSpecial</h4>
937 <b>setSpecial</b>(<i>special</i>) 1247 <b>setSpecial</b>(<i>special</i>)
1248
938 <p> 1249 <p>
939 Public method to set a special attribute for the context. 1250 Public method to set a special attribute for the context.
940 </p><dl> 1251 </p>
1252 <dl>
1253
941 <dt><i>special</i> (str)</dt> 1254 <dt><i>special</i> (str)</dt>
942 <dd> 1255 <dd>
943 attribute string 1256 attribute string
944 </dd> 1257 </dd>
945 </dl><a NAME="DocStyleContext.source" ID="DocStyleContext.source"></a> 1258 </dl>
1259 <a NAME="DocStyleContext.source" ID="DocStyleContext.source"></a>
946 <h4>DocStyleContext.source</h4> 1260 <h4>DocStyleContext.source</h4>
947 <b>source</b>(<i></i>) 1261 <b>source</b>(<i></i>)
1262
948 <p> 1263 <p>
949 Public method to get the source. 1264 Public method to get the source.
950 </p><dl> 1265 </p>
1266 <dl>
951 <dt>Returns:</dt> 1267 <dt>Returns:</dt>
952 <dd> 1268 <dd>
953 source (list of string) 1269 source (list of string)
954 </dd> 1270 </dd>
955 </dl><a NAME="DocStyleContext.special" ID="DocStyleContext.special"></a> 1271 </dl>
1272 <a NAME="DocStyleContext.special" ID="DocStyleContext.special"></a>
956 <h4>DocStyleContext.special</h4> 1273 <h4>DocStyleContext.special</h4>
957 <b>special</b>(<i></i>) 1274 <b>special</b>(<i></i>)
1275
958 <p> 1276 <p>
959 Public method to get the special context attribute string. 1277 Public method to get the special context attribute string.
960 </p><dl> 1278 </p>
1279 <dl>
961 <dt>Returns:</dt> 1280 <dt>Returns:</dt>
962 <dd> 1281 <dd>
963 attribute string 1282 attribute string
964 </dd> 1283 </dd>
965 </dl><dl> 1284 </dl>
1285 <dl>
966 <dt>Return Type:</dt> 1286 <dt>Return Type:</dt>
967 <dd> 1287 <dd>
968 str 1288 str
969 </dd> 1289 </dd>
970 </dl><a NAME="DocStyleContext.ssource" ID="DocStyleContext.ssource"></a> 1290 </dl>
1291 <a NAME="DocStyleContext.ssource" ID="DocStyleContext.ssource"></a>
971 <h4>DocStyleContext.ssource</h4> 1292 <h4>DocStyleContext.ssource</h4>
972 <b>ssource</b>(<i></i>) 1293 <b>ssource</b>(<i></i>)
1294
973 <p> 1295 <p>
974 Public method to get the joined source lines. 1296 Public method to get the joined source lines.
975 </p><dl> 1297 </p>
1298 <dl>
976 <dt>Returns:</dt> 1299 <dt>Returns:</dt>
977 <dd> 1300 <dd>
978 source (string) 1301 source (string)
979 </dd> 1302 </dd>
980 </dl><a NAME="DocStyleContext.start" ID="DocStyleContext.start"></a> 1303 </dl>
1304 <a NAME="DocStyleContext.start" ID="DocStyleContext.start"></a>
981 <h4>DocStyleContext.start</h4> 1305 <h4>DocStyleContext.start</h4>
982 <b>start</b>(<i></i>) 1306 <b>start</b>(<i></i>)
1307
983 <p> 1308 <p>
984 Public method to get the start line number. 1309 Public method to get the start line number.
985 </p><dl> 1310 </p>
1311 <dl>
986 <dt>Returns:</dt> 1312 <dt>Returns:</dt>
987 <dd> 1313 <dd>
988 start line number (integer) 1314 start line number (integer)
989 </dd> 1315 </dd>
990 </dl> 1316 </dl>

Mercurial Repository: eric

eric ide

mercurial