Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html

branch
eric7
changeset 10418
4573827e9815
parent 10259
b51dfacef37f
child 10457
4bef44d7a378
equal deleted inserted replaced
10417:c6011e501282 10418:4573827e9815
89 <tr> 89 <tr>
90 <td><a href="#DocStyleChecker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td> 90 <td><a href="#DocStyleChecker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td>
91 <td>Private method to check, that docstring summaries are followed by a blank line.</td> 91 <td>Private method to check, that docstring summaries are followed by a blank line.</td>
92 </tr> 92 </tr>
93 <tr> 93 <tr>
94 <td><a href="#DocStyleChecker.__checkEricDocumentationDeprecatedTags">__checkEricDocumentationDeprecatedTags</a></td>
95 <td>Private method to check the use of deprecated documentation tags.</td>
96 </tr>
97 <tr>
98 <td><a href="#DocStyleChecker.__checkEricDocumentationSequence">__checkEricDocumentationSequence</a></td>
99 <td>Private method to check, that method docstring follows the correct sequence of entries (e.g.</td>
100 </tr>
101 <tr>
94 <td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> 102 <td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td>
95 <td>Private method to check, that docstring summaries end with a period.</td> 103 <td>Private method to check, that docstring summaries end with a period.</td>
96 </tr> 104 </tr>
97 <tr> 105 <tr>
98 <td><a href="#DocStyleChecker.__checkEricException">__checkEricException</a></td> 106 <td><a href="#DocStyleChecker.__checkEricException">__checkEricException</a></td>
248 <p> 256 <p>
249 Constructor 257 Constructor
250 </p> 258 </p>
251 <dl> 259 <dl>
252 260
253 <dt><i>source</i></dt> 261 <dt><i>source</i> (list of str)</dt>
254 <dd> 262 <dd>
255 source code to be checked (list of string) 263 source code to be checked
256 </dd> 264 </dd>
257 <dt><i>filename</i></dt> 265 <dt><i>filename</i> (str)</dt>
258 <dd> 266 <dd>
259 name of the source file (string) 267 name of the source file
260 </dd> 268 </dd>
261 <dt><i>select</i></dt> 269 <dt><i>select</i> (list of str)</dt>
262 <dd> 270 <dd>
263 list of selected codes (list of string) 271 list of selected codes
264 </dd> 272 </dd>
265 <dt><i>ignore</i></dt> 273 <dt><i>ignore</i> (list of str)</dt>
266 <dd> 274 <dd>
267 list of codes to be ignored (list of string) 275 list of codes to be ignored
268 </dd> 276 </dd>
269 <dt><i>expected</i></dt> 277 <dt><i>expected</i> (list of str)</dt>
270 <dd> 278 <dd>
271 list of expected codes (list of string) 279 list of expected codes
272 </dd> 280 </dd>
273 <dt><i>repeat</i></dt> 281 <dt><i>repeat</i> (bool)</dt>
274 <dd> 282 <dd>
275 flag indicating to report each occurrence of a code 283 flag indicating to report each occurrence of a code
276 (boolean) 284 </dd>
277 </dd> 285 <dt><i>maxLineLength</i> (int)</dt>
278 <dt><i>maxLineLength</i></dt> 286 <dd>
279 <dd> 287 allowed line length
280 allowed line length (integer) 288 </dd>
281 </dd> 289 <dt><i>docType</i> (str)</dt>
282 <dt><i>docType</i></dt> 290 <dd>
283 <dd> 291 type of the documentation strings (one of 'eric' or 'pep257')
284 type of the documentation strings
285 (string, one of 'eric' or 'pep257')
286 </dd> 292 </dd>
287 </dl> 293 </dl>
288 <a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a> 294 <a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a>
289 <h4>DocStyleChecker.__checkBackslashes</h4> 295 <h4>DocStyleChecker.__checkBackslashes</h4>
290 <b>__checkBackslashes</b>(<i>docstringContext, context</i>) 296 <b>__checkBackslashes</b>(<i>docstringContext, context</i>)
293 Private method to check, that all docstrings containing 299 Private method to check, that all docstrings containing
294 backslashes are surrounded by raw triple double quotes. 300 backslashes are surrounded by raw triple double quotes.
295 </p> 301 </p>
296 <dl> 302 <dl>
297 303
298 <dt><i>docstringContext</i></dt> 304 <dt><i>docstringContext</i> (DocStyleContext)</dt>
299 <dd> 305 <dd>
300 docstring context (DocStyleContext) 306 docstring context
301 </dd> 307 </dd>
302 <dt><i>context</i></dt> 308 <dt><i>context</i> (DocStyleContext)</dt>
303 <dd> 309 <dd>
304 context of the docstring (DocStyleContext) 310 context of the docstring
305 </dd> 311 </dd>
306 </dl> 312 </dl>
307 <a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a> 313 <a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a>
308 <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4> 314 <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4>
309 <b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) 315 <b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>)
312 Private method to check, that the last paragraph of docstrings is 318 Private method to check, that the last paragraph of docstrings is
313 followed by a blank line. 319 followed by a blank line.
314 </p> 320 </p>
315 <dl> 321 <dl>
316 322
317 <dt><i>docstringContext</i></dt> 323 <dt><i>docstringContext</i> (DocStyleContext)</dt>
318 <dd> 324 <dd>
319 docstring context (DocStyleContext) 325 docstring context
320 </dd> 326 </dd>
321 <dt><i>context</i></dt> 327 <dt><i>context</i> (DocStyleContext)</dt>
322 <dd> 328 <dd>
323 context of the docstring (DocStyleContext) 329 context of the docstring
324 </dd> 330 </dd>
325 </dl> 331 </dl>
326 <a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a> 332 <a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a>
327 <h4>DocStyleChecker.__checkBlankAfterSummary</h4> 333 <h4>DocStyleChecker.__checkBlankAfterSummary</h4>
328 <b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>) 334 <b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>)
331 Private method to check, that docstring summaries are followed 337 Private method to check, that docstring summaries are followed
332 by a blank line. 338 by a blank line.
333 </p> 339 </p>
334 <dl> 340 <dl>
335 341
336 <dt><i>docstringContext</i></dt> 342 <dt><i>docstringContext</i> (DocStyleContext)</dt>
337 <dd> 343 <dd>
338 docstring context (DocStyleContext) 344 docstring context
339 </dd> 345 </dd>
340 <dt><i>context</i></dt> 346 <dt><i>context</i> (DocStyleContext)</dt>
341 <dd> 347 <dd>
342 context of the docstring (DocStyleContext) 348 context of the docstring
343 </dd> 349 </dd>
344 </dl> 350 </dl>
345 <a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a> 351 <a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a>
346 <h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4> 352 <h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4>
347 <b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) 353 <b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>)
350 Private method to check, that class docstrings have one 356 Private method to check, that class docstrings have one
351 blank line around them. 357 blank line around them.
352 </p> 358 </p>
353 <dl> 359 <dl>
354 360
355 <dt><i>docstringContext</i></dt> 361 <dt><i>docstringContext</i> (DocStyleContext)</dt>
356 <dd> 362 <dd>
357 docstring context (DocStyleContext) 363 docstring context
358 </dd> 364 </dd>
359 <dt><i>context</i></dt> 365 <dt><i>context</i> (DocStyleContext)</dt>
360 <dd> 366 <dd>
361 context of the docstring (DocStyleContext) 367 context of the docstring
362 </dd> 368 </dd>
363 </dl> 369 </dl>
364 <a NAME="DocStyleChecker.__checkClassDocstring" ID="DocStyleChecker.__checkClassDocstring"></a> 370 <a NAME="DocStyleChecker.__checkClassDocstring" ID="DocStyleChecker.__checkClassDocstring"></a>
365 <h4>DocStyleChecker.__checkClassDocstring</h4> 371 <h4>DocStyleChecker.__checkClassDocstring</h4>
366 <b>__checkClassDocstring</b>(<i>docstringContext, context</i>) 372 <b>__checkClassDocstring</b>(<i>docstringContext, context</i>)
369 Private method to check, that all public functions and methods 375 Private method to check, that all public functions and methods
370 have a docstring. 376 have a docstring.
371 </p> 377 </p>
372 <dl> 378 <dl>
373 379
374 <dt><i>docstringContext</i></dt> 380 <dt><i>docstringContext</i> (DocStyleContext)</dt>
375 <dd> 381 <dd>
376 docstring context (DocStyleContext) 382 docstring context
377 </dd> 383 </dd>
378 <dt><i>context</i></dt> 384 <dt><i>context</i> (DocStyleContext)</dt>
379 <dd> 385 <dd>
380 context of the docstring (DocStyleContext) 386 context of the docstring
381 </dd> 387 </dd>
382 </dl> 388 </dl>
383 <a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a> 389 <a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a>
384 <h4>DocStyleChecker.__checkEndsWithPeriod</h4> 390 <h4>DocStyleChecker.__checkEndsWithPeriod</h4>
385 <b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>) 391 <b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>)
387 <p> 393 <p>
388 Private method to check, that docstring summaries end with a period. 394 Private method to check, that docstring summaries end with a period.
389 </p> 395 </p>
390 <dl> 396 <dl>
391 397
392 <dt><i>docstringContext</i></dt> 398 <dt><i>docstringContext</i> (DocStyleContext)</dt>
393 <dd> 399 <dd>
394 docstring context (DocStyleContext) 400 docstring context
395 </dd> 401 </dd>
396 <dt><i>context</i></dt> 402 <dt><i>context</i> (DocStyleContext)</dt>
397 <dd> 403 <dd>
398 context of the docstring (DocStyleContext) 404 context of the docstring
399 </dd> 405 </dd>
400 </dl> 406 </dl>
401 <a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a> 407 <a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a>
402 <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4> 408 <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4>
403 <b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>) 409 <b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>)
406 Private method to check, that docstring summaries are followed 412 Private method to check, that docstring summaries are followed
407 by a blank line. 413 by a blank line.
408 </p> 414 </p>
409 <dl> 415 <dl>
410 416
411 <dt><i>docstringContext</i></dt> 417 <dt><i>docstringContext</i> (DocStyleContext)</dt>
412 <dd> 418 <dd>
413 docstring context (DocStyleContext) 419 docstring context
414 </dd> 420 </dd>
415 <dt><i>context</i></dt> 421 <dt><i>context</i> (DocStyleContext)</dt>
416 <dd> 422 <dd>
417 context of the docstring (DocStyleContext) 423 context of the docstring
424 </dd>
425 </dl>
426 <a NAME="DocStyleChecker.__checkEricDocumentationDeprecatedTags" ID="DocStyleChecker.__checkEricDocumentationDeprecatedTags"></a>
427 <h4>DocStyleChecker.__checkEricDocumentationDeprecatedTags</h4>
428 <b>__checkEricDocumentationDeprecatedTags</b>(<i>docstringContext, context, </i>)
429
430 <p>
431 Private method to check the use of deprecated documentation tags.
432 </p>
433 <dl>
434
435 <dt><i>docstringContext</i> (DocStyleContext)</dt>
436 <dd>
437 docstring context
438 </dd>
439 <dt><i>context</i> (DocStyleContext)</dt>
440 <dd>
441 context of the docstring
442 </dd>
443 </dl>
444 <a NAME="DocStyleChecker.__checkEricDocumentationSequence" ID="DocStyleChecker.__checkEricDocumentationSequence"></a>
445 <h4>DocStyleChecker.__checkEricDocumentationSequence</h4>
446 <b>__checkEricDocumentationSequence</b>(<i>docstringContext, context, </i>)
447
448 <p>
449 Private method to check, that method docstring follows the correct sequence
450 of entries (e.g. @param is followed by @type).
451 </p>
452 <dl>
453
454 <dt><i>docstringContext</i> (DocStyleContext)</dt>
455 <dd>
456 docstring context
457 </dd>
458 <dt><i>context</i> (DocStyleContext)</dt>
459 <dd>
460 context of the docstring
418 </dd> 461 </dd>
419 </dl> 462 </dl>
420 <a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a> 463 <a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a>
421 <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4> 464 <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4>
422 <b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>) 465 <b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>)
424 <p> 467 <p>
425 Private method to check, that docstring summaries end with a period. 468 Private method to check, that docstring summaries end with a period.
426 </p> 469 </p>
427 <dl> 470 <dl>
428 471
429 <dt><i>docstringContext</i></dt> 472 <dt><i>docstringContext</i> (DocStyleContext)</dt>
430 <dd> 473 <dd>
431 docstring context (DocStyleContext) 474 docstring context
432 </dd> 475 </dd>
433 <dt><i>context</i></dt> 476 <dt><i>context</i> (DocStyleContext)</dt>
434 <dd> 477 <dd>
435 context of the docstring (DocStyleContext) 478 context of the docstring
436 </dd> 479 </dd>
437 </dl> 480 </dl>
438 <a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a> 481 <a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a>
439 <h4>DocStyleChecker.__checkEricException</h4> 482 <h4>DocStyleChecker.__checkEricException</h4>
440 <b>__checkEricException</b>(<i>docstringContext, context</i>) 483 <b>__checkEricException</b>(<i>docstringContext, context</i>)
448 completeness (i.e. raised exceptions that are not documented or 491 completeness (i.e. raised exceptions that are not documented or
449 documented exceptions that are not raised) 492 documented exceptions that are not raised)
450 </p> 493 </p>
451 <dl> 494 <dl>
452 495
453 <dt><i>docstringContext</i></dt> 496 <dt><i>docstringContext</i> (DocStyleContext)</dt>
454 <dd> 497 <dd>
455 docstring context (DocStyleContext) 498 docstring context
456 </dd> 499 </dd>
457 <dt><i>context</i></dt> 500 <dt><i>context</i> (DocStyleContext)</dt>
458 <dd> 501 <dd>
459 context of the docstring (DocStyleContext) 502 context of the docstring
460 </dd> 503 </dd>
461 </dl> 504 </dl>
462 <a NAME="DocStyleChecker.__checkEricFunctionArguments" ID="DocStyleChecker.__checkEricFunctionArguments"></a> 505 <a NAME="DocStyleChecker.__checkEricFunctionArguments" ID="DocStyleChecker.__checkEricFunctionArguments"></a>
463 <h4>DocStyleChecker.__checkEricFunctionArguments</h4> 506 <h4>DocStyleChecker.__checkEricFunctionArguments</h4>
464 <b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>) 507 <b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>)
467 Private method to check, that docstrings contain an &#64;param and/or 510 Private method to check, that docstrings contain an &#64;param and/or
468 &#64;keyparam line for each argument. 511 &#64;keyparam line for each argument.
469 </p> 512 </p>
470 <dl> 513 <dl>
471 514
472 <dt><i>docstringContext</i></dt> 515 <dt><i>docstringContext</i> (DocStyleContext)</dt>
473 <dd> 516 <dd>
474 docstring context (DocStyleContext) 517 docstring context
475 </dd> 518 </dd>
476 <dt><i>context</i></dt> 519 <dt><i>context</i> (DocStyleContext)</dt>
477 <dd> 520 <dd>
478 context of the docstring (DocStyleContext) 521 context of the docstring
479 </dd> 522 </dd>
480 </dl> 523 </dl>
481 <a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a> 524 <a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a>
482 <h4>DocStyleChecker.__checkEricNBlankAfterLastParagraph</h4> 525 <h4>DocStyleChecker.__checkEricNBlankAfterLastParagraph</h4>
483 <b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) 526 <b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, context</i>)
486 Private method to check, that the last paragraph of docstrings is 529 Private method to check, that the last paragraph of docstrings is
487 not followed by a blank line. 530 not followed by a blank line.
488 </p> 531 </p>
489 <dl> 532 <dl>
490 533
491 <dt><i>docstringContext</i></dt> 534 <dt><i>docstringContext</i> (DocStyleContext)</dt>
492 <dd> 535 <dd>
493 docstring context (DocStyleContext) 536 docstring context
494 </dd> 537 </dd>
495 <dt><i>context</i></dt> 538 <dt><i>context</i> (DocStyleContext)</dt>
496 <dd> 539 <dd>
497 context of the docstring (DocStyleContext) 540 context of the docstring
498 </dd> 541 </dd>
499 </dl> 542 </dl>
500 <a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> 543 <a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a>
501 <h4>DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4> 544 <h4>DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4>
502 <b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>) 545 <b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>)
505 Private method to check, that class and function/method docstrings 548 Private method to check, that class and function/method docstrings
506 have no blank line around them. 549 have no blank line around them.
507 </p> 550 </p>
508 <dl> 551 <dl>
509 552
510 <dt><i>docstringContext</i></dt> 553 <dt><i>docstringContext</i> (DocStyleContext)</dt>
511 <dd> 554 <dd>
512 docstring context (DocStyleContext) 555 docstring context
513 </dd> 556 </dd>
514 <dt><i>context</i></dt> 557 <dt><i>context</i> (DocStyleContext)</dt>
515 <dd> 558 <dd>
516 context of the docstring (DocStyleContext) 559 context of the docstring
517 </dd> 560 </dd>
518 </dl> 561 </dl>
519 <a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a> 562 <a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a>
520 <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4> 563 <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4>
521 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) 564 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>)
524 Private method to check, that leading and trailing quotes are on 567 Private method to check, that leading and trailing quotes are on
525 a line by themselves. 568 a line by themselves.
526 </p> 569 </p>
527 <dl> 570 <dl>
528 571
529 <dt><i>docstringContext</i></dt> 572 <dt><i>docstringContext</i> (DocStyleContext)</dt>
530 <dd> 573 <dd>
531 docstring context (DocStyleContext) 574 docstring context
532 </dd> 575 </dd>
533 <dt><i>context</i></dt> 576 <dt><i>context</i> (DocStyleContext)</dt>
534 <dd> 577 <dd>
535 context of the docstring (DocStyleContext) 578 context of the docstring
536 </dd> 579 </dd>
537 </dl> 580 </dl>
538 <a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a> 581 <a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a>
539 <h4>DocStyleChecker.__checkEricReturn</h4> 582 <h4>DocStyleChecker.__checkEricReturn</h4>
540 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) 583 <b>__checkEricReturn</b>(<i>docstringContext, context</i>)
543 Private method to check, that docstrings contain an &#64;return line 586 Private method to check, that docstrings contain an &#64;return line
544 if they return anything and don't otherwise. 587 if they return anything and don't otherwise.
545 </p> 588 </p>
546 <dl> 589 <dl>
547 590
548 <dt><i>docstringContext</i></dt> 591 <dt><i>docstringContext</i> (DocStyleContext)</dt>
549 <dd> 592 <dd>
550 docstring context (DocStyleContext) 593 docstring context
551 </dd> 594 </dd>
552 <dt><i>context</i></dt> 595 <dt><i>context</i> (DocStyleContext)</dt>
553 <dd> 596 <dd>
554 context of the docstring (DocStyleContext) 597 context of the docstring
555 </dd> 598 </dd>
556 </dl> 599 </dl>
557 <a NAME="DocStyleChecker.__checkEricSignal" ID="DocStyleChecker.__checkEricSignal"></a> 600 <a NAME="DocStyleChecker.__checkEricSignal" ID="DocStyleChecker.__checkEricSignal"></a>
558 <h4>DocStyleChecker.__checkEricSignal</h4> 601 <h4>DocStyleChecker.__checkEricSignal</h4>
559 <b>__checkEricSignal</b>(<i>docstringContext, context</i>) 602 <b>__checkEricSignal</b>(<i>docstringContext, context</i>)
567 completeness (i.e. defined signals that are not documented or 610 completeness (i.e. defined signals that are not documented or
568 documented signals that are not defined) 611 documented signals that are not defined)
569 </p> 612 </p>
570 <dl> 613 <dl>
571 614
572 <dt><i>docstringContext</i></dt> 615 <dt><i>docstringContext</i> (DocStyleContext)</dt>
573 <dd> 616 <dd>
574 docstring context (DocStyleContext) 617 docstring context
575 </dd> 618 </dd>
576 <dt><i>context</i></dt> 619 <dt><i>context</i> (DocStyleContext)</dt>
577 <dd> 620 <dd>
578 context of the docstring (DocStyleContext) 621 context of the docstring
579 </dd> 622 </dd>
580 </dl> 623 </dl>
581 <a NAME="DocStyleChecker.__checkEricSummary" ID="DocStyleChecker.__checkEricSummary"></a> 624 <a NAME="DocStyleChecker.__checkEricSummary" ID="DocStyleChecker.__checkEricSummary"></a>
582 <h4>DocStyleChecker.__checkEricSummary</h4> 625 <h4>DocStyleChecker.__checkEricSummary</h4>
583 <b>__checkEricSummary</b>(<i>docstringContext, context</i>) 626 <b>__checkEricSummary</b>(<i>docstringContext, context</i>)
586 Private method to check, that method docstring summaries start with 629 Private method to check, that method docstring summaries start with
587 specific words. 630 specific words.
588 </p> 631 </p>
589 <dl> 632 <dl>
590 633
591 <dt><i>docstringContext</i></dt> 634 <dt><i>docstringContext</i> (DocStyleContext)</dt>
592 <dd> 635 <dd>
593 docstring context (DocStyleContext) 636 docstring context
594 </dd> 637 </dd>
595 <dt><i>context</i></dt> 638 <dt><i>context</i> (DocStyleContext)</dt>
596 <dd> 639 <dd>
597 context of the docstring (DocStyleContext) 640 context of the docstring
598 </dd> 641 </dd>
599 </dl> 642 </dl>
600 <a NAME="DocStyleChecker.__checkEricYield" ID="DocStyleChecker.__checkEricYield"></a> 643 <a NAME="DocStyleChecker.__checkEricYield" ID="DocStyleChecker.__checkEricYield"></a>
601 <h4>DocStyleChecker.__checkEricYield</h4> 644 <h4>DocStyleChecker.__checkEricYield</h4>
602 <b>__checkEricYield</b>(<i>docstringContext, context</i>) 645 <b>__checkEricYield</b>(<i>docstringContext, context</i>)
605 Private method to check, that docstrings contain an &#64;yield line 648 Private method to check, that docstrings contain an &#64;yield line
606 if they return anything and don't otherwise. 649 if they return anything and don't otherwise.
607 </p> 650 </p>
608 <dl> 651 <dl>
609 652
610 <dt><i>docstringContext</i></dt> 653 <dt><i>docstringContext</i> (DocStyleContext)</dt>
611 <dd> 654 <dd>
612 docstring context (DocStyleContext) 655 docstring context
613 </dd> 656 </dd>
614 <dt><i>context</i></dt> 657 <dt><i>context</i> (DocStyleContext)</dt>
615 <dd> 658 <dd>
616 context of the docstring (DocStyleContext) 659 context of the docstring
617 </dd> 660 </dd>
618 </dl> 661 </dl>
619 <a NAME="DocStyleChecker.__checkFunctionDocstring" ID="DocStyleChecker.__checkFunctionDocstring"></a> 662 <a NAME="DocStyleChecker.__checkFunctionDocstring" ID="DocStyleChecker.__checkFunctionDocstring"></a>
620 <h4>DocStyleChecker.__checkFunctionDocstring</h4> 663 <h4>DocStyleChecker.__checkFunctionDocstring</h4>
621 <b>__checkFunctionDocstring</b>(<i>docstringContext, context</i>) 664 <b>__checkFunctionDocstring</b>(<i>docstringContext, context</i>)
624 Private method to check, that all public functions and methods 667 Private method to check, that all public functions and methods
625 have a docstring. 668 have a docstring.
626 </p> 669 </p>
627 <dl> 670 <dl>
628 671
629 <dt><i>docstringContext</i></dt> 672 <dt><i>docstringContext</i> (DocStyleContext)</dt>
630 <dd> 673 <dd>
631 docstring context (DocStyleContext) 674 docstring context
632 </dd> 675 </dd>
633 <dt><i>context</i></dt> 676 <dt><i>context</i> (DocStyleContext)</dt>
634 <dd> 677 <dd>
635 context of the docstring (DocStyleContext) 678 context of the docstring
636 </dd> 679 </dd>
637 </dl> 680 </dl>
638 <a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a> 681 <a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a>
639 <h4>DocStyleChecker.__checkImperativeMood</h4> 682 <h4>DocStyleChecker.__checkImperativeMood</h4>
640 <b>__checkImperativeMood</b>(<i>docstringContext, context</i>) 683 <b>__checkImperativeMood</b>(<i>docstringContext, context</i>)
643 Private method to check, that docstring summaries are in 686 Private method to check, that docstring summaries are in
644 imperative mood. 687 imperative mood.
645 </p> 688 </p>
646 <dl> 689 <dl>
647 690
648 <dt><i>docstringContext</i></dt> 691 <dt><i>docstringContext</i> (DocStyleContext)</dt>
649 <dd> 692 <dd>
650 docstring context (DocStyleContext) 693 docstring context
651 </dd> 694 </dd>
652 <dt><i>context</i></dt> 695 <dt><i>context</i> (DocStyleContext)</dt>
653 <dd> 696 <dd>
654 context of the docstring (DocStyleContext) 697 context of the docstring
655 </dd> 698 </dd>
656 </dl> 699 </dl>
657 <a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a> 700 <a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a>
658 <h4>DocStyleChecker.__checkIndent</h4> 701 <h4>DocStyleChecker.__checkIndent</h4>
659 <b>__checkIndent</b>(<i>docstringContext, context</i>) 702 <b>__checkIndent</b>(<i>docstringContext, context</i>)
661 <p> 704 <p>
662 Private method to check, that docstrings are properly indented. 705 Private method to check, that docstrings are properly indented.
663 </p> 706 </p>
664 <dl> 707 <dl>
665 708
666 <dt><i>docstringContext</i></dt> 709 <dt><i>docstringContext</i> (DocStyleContext)</dt>
667 <dd> 710 <dd>
668 docstring context (DocStyleContext) 711 docstring context
669 </dd> 712 </dd>
670 <dt><i>context</i></dt> 713 <dt><i>context</i> (DocStyleContext)</dt>
671 <dd> 714 <dd>
672 context of the docstring (DocStyleContext) 715 context of the docstring
673 </dd> 716 </dd>
674 </dl> 717 </dl>
675 <a NAME="DocStyleChecker.__checkModulesDocstrings" ID="DocStyleChecker.__checkModulesDocstrings"></a> 718 <a NAME="DocStyleChecker.__checkModulesDocstrings" ID="DocStyleChecker.__checkModulesDocstrings"></a>
676 <h4>DocStyleChecker.__checkModulesDocstrings</h4> 719 <h4>DocStyleChecker.__checkModulesDocstrings</h4>
677 <b>__checkModulesDocstrings</b>(<i>docstringContext, context</i>) 720 <b>__checkModulesDocstrings</b>(<i>docstringContext, context</i>)
679 <p> 722 <p>
680 Private method to check, if the module has a docstring. 723 Private method to check, if the module has a docstring.
681 </p> 724 </p>
682 <dl> 725 <dl>
683 726
684 <dt><i>docstringContext</i></dt> 727 <dt><i>docstringContext</i> (DocStyleContext)</dt>
685 <dd> 728 <dd>
686 docstring context (DocStyleContext) 729 docstring context
687 </dd> 730 </dd>
688 <dt><i>context</i></dt> 731 <dt><i>context</i> (DocStyleContext)</dt>
689 <dd> 732 <dd>
690 context of the docstring (DocStyleContext) 733 context of the docstring
691 </dd> 734 </dd>
692 </dl> 735 </dl>
693 <a NAME="DocStyleChecker.__checkNoBlankLineBefore" ID="DocStyleChecker.__checkNoBlankLineBefore"></a> 736 <a NAME="DocStyleChecker.__checkNoBlankLineBefore" ID="DocStyleChecker.__checkNoBlankLineBefore"></a>
694 <h4>DocStyleChecker.__checkNoBlankLineBefore</h4> 737 <h4>DocStyleChecker.__checkNoBlankLineBefore</h4>
695 <b>__checkNoBlankLineBefore</b>(<i>docstringContext, context</i>) 738 <b>__checkNoBlankLineBefore</b>(<i>docstringContext, context</i>)
698 Private method to check, that function/method docstrings are not 741 Private method to check, that function/method docstrings are not
699 preceded by a blank line. 742 preceded by a blank line.
700 </p> 743 </p>
701 <dl> 744 <dl>
702 745
703 <dt><i>docstringContext</i></dt> 746 <dt><i>docstringContext</i> (DocStyleContext)</dt>
704 <dd> 747 <dd>
705 docstring context (DocStyleContext) 748 docstring context
706 </dd> 749 </dd>
707 <dt><i>context</i></dt> 750 <dt><i>context</i> (DocStyleContext)</dt>
708 <dd> 751 <dd>
709 context of the docstring (DocStyleContext) 752 context of the docstring
710 </dd> 753 </dd>
711 </dl> 754 </dl>
712 <a NAME="DocStyleChecker.__checkNoSignature" ID="DocStyleChecker.__checkNoSignature"></a> 755 <a NAME="DocStyleChecker.__checkNoSignature" ID="DocStyleChecker.__checkNoSignature"></a>
713 <h4>DocStyleChecker.__checkNoSignature</h4> 756 <h4>DocStyleChecker.__checkNoSignature</h4>
714 <b>__checkNoSignature</b>(<i>docstringContext, context</i>) 757 <b>__checkNoSignature</b>(<i>docstringContext, context</i>)
717 Private method to check, that docstring summaries don't repeat 760 Private method to check, that docstring summaries don't repeat
718 the function's signature. 761 the function's signature.
719 </p> 762 </p>
720 <dl> 763 <dl>
721 764
722 <dt><i>docstringContext</i></dt> 765 <dt><i>docstringContext</i> (DocStyleContext)</dt>
723 <dd> 766 <dd>
724 docstring context (DocStyleContext) 767 docstring context
725 </dd> 768 </dd>
726 <dt><i>context</i></dt> 769 <dt><i>context</i> (DocStyleContext)</dt>
727 <dd> 770 <dd>
728 context of the docstring (DocStyleContext) 771 context of the docstring
729 </dd> 772 </dd>
730 </dl> 773 </dl>
731 <a NAME="DocStyleChecker.__checkOneLiner" ID="DocStyleChecker.__checkOneLiner"></a> 774 <a NAME="DocStyleChecker.__checkOneLiner" ID="DocStyleChecker.__checkOneLiner"></a>
732 <h4>DocStyleChecker.__checkOneLiner</h4> 775 <h4>DocStyleChecker.__checkOneLiner</h4>
733 <b>__checkOneLiner</b>(<i>docstringContext, context</i>) 776 <b>__checkOneLiner</b>(<i>docstringContext, context</i>)
736 Private method to check, that one-liner docstrings fit on 779 Private method to check, that one-liner docstrings fit on
737 one line with quotes. 780 one line with quotes.
738 </p> 781 </p>
739 <dl> 782 <dl>
740 783
741 <dt><i>docstringContext</i></dt> 784 <dt><i>docstringContext</i> (DocStyleContext)</dt>
742 <dd> 785 <dd>
743 docstring context (DocStyleContext) 786 docstring context
744 </dd> 787 </dd>
745 <dt><i>context</i></dt> 788 <dt><i>context</i> (DocStyleContext)</dt>
746 <dd> 789 <dd>
747 context of the docstring (DocStyleContext) 790 context of the docstring
748 </dd> 791 </dd>
749 </dl> 792 </dl>
750 <a NAME="DocStyleChecker.__checkReturnType" ID="DocStyleChecker.__checkReturnType"></a> 793 <a NAME="DocStyleChecker.__checkReturnType" ID="DocStyleChecker.__checkReturnType"></a>
751 <h4>DocStyleChecker.__checkReturnType</h4> 794 <h4>DocStyleChecker.__checkReturnType</h4>
752 <b>__checkReturnType</b>(<i>docstringContext, context</i>) 795 <b>__checkReturnType</b>(<i>docstringContext, context</i>)
754 <p> 797 <p>
755 Private method to check, that docstrings mention the return value type. 798 Private method to check, that docstrings mention the return value type.
756 </p> 799 </p>
757 <dl> 800 <dl>
758 801
759 <dt><i>docstringContext</i></dt> 802 <dt><i>docstringContext</i> (DocStyleContext)</dt>
760 <dd> 803 <dd>
761 docstring context (DocStyleContext) 804 docstring context
762 </dd> 805 </dd>
763 <dt><i>context</i></dt> 806 <dt><i>context</i> (DocStyleContext)</dt>
764 <dd> 807 <dd>
765 context of the docstring (DocStyleContext) 808 context of the docstring
766 </dd> 809 </dd>
767 </dl> 810 </dl>
768 <a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a> 811 <a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a>
769 <h4>DocStyleChecker.__checkSummary</h4> 812 <h4>DocStyleChecker.__checkSummary</h4>
770 <b>__checkSummary</b>(<i>docstringContext, context</i>) 813 <b>__checkSummary</b>(<i>docstringContext, context</i>)
772 <p> 815 <p>
773 Private method to check, that docstring summaries contain some text. 816 Private method to check, that docstring summaries contain some text.
774 </p> 817 </p>
775 <dl> 818 <dl>
776 819
777 <dt><i>docstringContext</i></dt> 820 <dt><i>docstringContext</i> (DocStyleContext)</dt>
778 <dd> 821 <dd>
779 docstring context (DocStyleContext) 822 docstring context
780 </dd> 823 </dd>
781 <dt><i>context</i></dt> 824 <dt><i>context</i> (DocStyleContext)</dt>
782 <dd> 825 <dd>
783 context of the docstring (DocStyleContext) 826 context of the docstring
784 </dd> 827 </dd>
785 </dl> 828 </dl>
786 <a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a> 829 <a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a>
787 <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4> 830 <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4>
788 <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>) 831 <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>)
791 Private method to check, that all docstrings are surrounded 834 Private method to check, that all docstrings are surrounded
792 by triple double quotes. 835 by triple double quotes.
793 </p> 836 </p>
794 <dl> 837 <dl>
795 838
796 <dt><i>docstringContext</i></dt> 839 <dt><i>docstringContext</i> (DocStyleContext)</dt>
797 <dd> 840 <dd>
798 docstring context (DocStyleContext) 841 docstring context
799 </dd> 842 </dd>
800 <dt><i>context</i></dt> 843 <dt><i>context</i> (DocStyleContext)</dt>
801 <dd> 844 <dd>
802 context of the docstring (DocStyleContext) 845 context of the docstring
803 </dd> 846 </dd>
804 </dl> 847 </dl>
805 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> 848 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a>
806 <h4>DocStyleChecker.__error</h4> 849 <h4>DocStyleChecker.__error</h4>
807 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) 850 <b>__error</b>(<i>lineNumber, offset, code, *args</i>)
809 <p> 852 <p>
810 Private method to record an issue. 853 Private method to record an issue.
811 </p> 854 </p>
812 <dl> 855 <dl>
813 856
814 <dt><i>lineNumber</i></dt> 857 <dt><i>lineNumber</i> (int)</dt>
815 <dd> 858 <dd>
816 line number of the issue (integer) 859 line number of the issue
817 </dd> 860 </dd>
818 <dt><i>offset</i></dt> 861 <dt><i>offset</i> (int)</dt>
819 <dd> 862 <dd>
820 position within line of the issue (integer) 863 position within line of the issue
821 </dd> 864 </dd>
822 <dt><i>code</i></dt> 865 <dt><i>code</i> (str)</dt>
823 <dd> 866 <dd>
824 message code (string) 867 message code
825 </dd> 868 </dd>
826 <dt><i>args</i></dt> 869 <dt><i>args</i> (list)</dt>
827 <dd> 870 <dd>
828 arguments for the message (list) 871 arguments for the message
829 </dd> 872 </dd>
830 </dl> 873 </dl>
831 <a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a> 874 <a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a>
832 <h4>DocStyleChecker.__getArgNames</h4> 875 <h4>DocStyleChecker.__getArgNames</h4>
833 <b>__getArgNames</b>(<i>node</i>) 876 <b>__getArgNames</b>(<i>node</i>)
835 <p> 878 <p>
836 Private method to get the argument names of a function node. 879 Private method to get the argument names of a function node.
837 </p> 880 </p>
838 <dl> 881 <dl>
839 882
840 <dt><i>node</i></dt> 883 <dt><i>node</i> (ast.AST)</dt>
841 <dd> 884 <dd>
842 AST node to extract arguments names from 885 AST node to extract arguments names from
843 </dd> 886 </dd>
844 </dl> 887 </dl>
845 <dl> 888 <dl>
846 <dt>Return:</dt> 889 <dt>Return:</dt>
847 <dd> 890 <dd>
848 tuple of two list of argument names, one for arguments 891 tuple of two list of argument names, one for arguments
849 and one for keyword arguments (tuple of list of string) 892 and one for keyword arguments
893 </dd>
894 </dl>
895 <dl>
896 <dt>Return Type:</dt>
897 <dd>
898 tuple of (list of str, list of str)
850 </dd> 899 </dd>
851 </dl> 900 </dl>
852 <a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a> 901 <a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a>
853 <h4>DocStyleChecker.__getSummaryLine</h4> 902 <h4>DocStyleChecker.__getSummaryLine</h4>
854 <b>__getSummaryLine</b>(<i>docstringContext</i>) 903 <b>__getSummaryLine</b>(<i>docstringContext</i>)
856 <p> 905 <p>
857 Private method to extract the summary line. 906 Private method to extract the summary line.
858 </p> 907 </p>
859 <dl> 908 <dl>
860 909
861 <dt><i>docstringContext</i></dt> 910 <dt><i>docstringContext</i> (DocStyleContext)</dt>
862 <dd> 911 <dd>
863 docstring context (DocStyleContext) 912 docstring context
864 </dd> 913 </dd>
865 </dl> 914 </dl>
866 <dl> 915 <dl>
867 <dt>Return:</dt> 916 <dt>Return:</dt>
868 <dd> 917 <dd>
869 summary line (string) and the line it was found on (integer) 918 summary line (string) and the line it was found on
919 </dd>
920 </dl>
921 <dl>
922 <dt>Return Type:</dt>
923 <dd>
924 int
870 </dd> 925 </dd>
871 </dl> 926 </dl>
872 <a NAME="DocStyleChecker.__getSummaryLines" ID="DocStyleChecker.__getSummaryLines"></a> 927 <a NAME="DocStyleChecker.__getSummaryLines" ID="DocStyleChecker.__getSummaryLines"></a>
873 <h4>DocStyleChecker.__getSummaryLines</h4> 928 <h4>DocStyleChecker.__getSummaryLines</h4>
874 <b>__getSummaryLines</b>(<i>docstringContext</i>) 929 <b>__getSummaryLines</b>(<i>docstringContext</i>)
876 <p> 931 <p>
877 Private method to extract the summary lines. 932 Private method to extract the summary lines.
878 </p> 933 </p>
879 <dl> 934 <dl>
880 935
881 <dt><i>docstringContext</i></dt> 936 <dt><i>docstringContext</i> (DocStyleContext)</dt>
882 <dd> 937 <dd>
883 docstring context (DocStyleContext) 938 docstring context
884 </dd> 939 </dd>
885 </dl> 940 </dl>
886 <dl> 941 <dl>
887 <dt>Return:</dt> 942 <dt>Return:</dt>
888 <dd> 943 <dd>
889 summary lines (list of string) and the line it was found on 944 summary lines (list of string) and the line it was found on
890 (integer) 945 </dd>
946 </dl>
947 <dl>
948 <dt>Return Type:</dt>
949 <dd>
950 int
891 </dd> 951 </dd>
892 </dl> 952 </dl>
893 <a NAME="DocStyleChecker.__ignoreCode" ID="DocStyleChecker.__ignoreCode"></a> 953 <a NAME="DocStyleChecker.__ignoreCode" ID="DocStyleChecker.__ignoreCode"></a>
894 <h4>DocStyleChecker.__ignoreCode</h4> 954 <h4>DocStyleChecker.__ignoreCode</h4>
895 <b>__ignoreCode</b>(<i>code</i>) 955 <b>__ignoreCode</b>(<i>code</i>)
897 <p> 957 <p>
898 Private method to check if the error code should be ignored. 958 Private method to check if the error code should be ignored.
899 </p> 959 </p>
900 <dl> 960 <dl>
901 961
902 <dt><i>code</i></dt> 962 <dt><i>code</i> (str)</dt>
903 <dd> 963 <dd>
904 message code to check for (string) 964 message code to check for
905 </dd> 965 </dd>
906 </dl> 966 </dl>
907 <dl> 967 <dl>
908 <dt>Return:</dt> 968 <dt>Return:</dt>
909 <dd> 969 <dd>
910 flag indicating to ignore the given code (boolean) 970 flag indicating to ignore the given code
971 </dd>
972 </dl>
973 <dl>
974 <dt>Return Type:</dt>
975 <dd>
976 bool
911 </dd> 977 </dd>
912 </dl> 978 </dl>
913 <a NAME="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a> 979 <a NAME="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a>
914 <h4>DocStyleChecker.__parseClasses</h4> 980 <h4>DocStyleChecker.__parseClasses</h4>
915 <b>__parseClasses</b>(<i></i>) 981 <b>__parseClasses</b>(<i></i>)
918 Private method to extract top-level classes. 984 Private method to extract top-level classes.
919 </p> 985 </p>
920 <dl> 986 <dl>
921 <dt>Return:</dt> 987 <dt>Return:</dt>
922 <dd> 988 <dd>
923 extracted class contexts (list of DocStyleContext) 989 extracted class contexts
990 </dd>
991 </dl>
992 <dl>
993 <dt>Return Type:</dt>
994 <dd>
995 list of DocStyleContext
924 </dd> 996 </dd>
925 </dl> 997 </dl>
926 <a NAME="DocStyleChecker.__parseContexts" ID="DocStyleChecker.__parseContexts"></a> 998 <a NAME="DocStyleChecker.__parseContexts" ID="DocStyleChecker.__parseContexts"></a>
927 <h4>DocStyleChecker.__parseContexts</h4> 999 <h4>DocStyleChecker.__parseContexts</h4>
928 <b>__parseContexts</b>(<i>kind</i>) 1000 <b>__parseContexts</b>(<i>kind</i>)
930 <p> 1002 <p>
931 Private method to extract a context from the source. 1003 Private method to extract a context from the source.
932 </p> 1004 </p>
933 <dl> 1005 <dl>
934 1006
935 <dt><i>kind</i></dt> 1007 <dt><i>kind</i> (str)</dt>
936 <dd> 1008 <dd>
937 kind of context to extract (string) 1009 kind of context to extract
938 </dd> 1010 </dd>
939 </dl> 1011 </dl>
940 <dl> 1012 <dl>
941 <dt>Return:</dt> 1013 <dt>Return:</dt>
942 <dd> 1014 <dd>
943 requested contexts (list of DocStyleContext) 1015 requested contexts
1016 </dd>
1017 </dl>
1018 <dl>
1019 <dt>Return Type:</dt>
1020 <dd>
1021 list of DocStyleContext
944 </dd> 1022 </dd>
945 </dl> 1023 </dl>
946 <a NAME="DocStyleChecker.__parseDocstring" ID="DocStyleChecker.__parseDocstring"></a> 1024 <a NAME="DocStyleChecker.__parseDocstring" ID="DocStyleChecker.__parseDocstring"></a>
947 <h4>DocStyleChecker.__parseDocstring</h4> 1025 <h4>DocStyleChecker.__parseDocstring</h4>
948 <b>__parseDocstring</b>(<i>context, what=""</i>) 1026 <b>__parseDocstring</b>(<i>context, what=""</i>)
950 <p> 1028 <p>
951 Private method to extract a docstring given `def` or `class` source. 1029 Private method to extract a docstring given `def` or `class` source.
952 </p> 1030 </p>
953 <dl> 1031 <dl>
954 1032
955 <dt><i>context</i></dt> 1033 <dt><i>context</i> (DocStyleContext)</dt>
956 <dd> 1034 <dd>
957 context data to get the docstring from (DocStyleContext) 1035 context data to get the docstring from
958 </dd> 1036 </dd>
959 <dt><i>what</i></dt> 1037 <dt><i>what</i> (str)</dt>
960 <dd> 1038 <dd>
961 string denoting what is being parsed (string) 1039 string denoting what is being parsed
962 </dd> 1040 </dd>
963 </dl> 1041 </dl>
964 <dl> 1042 <dl>
965 <dt>Return:</dt> 1043 <dt>Return:</dt>
966 <dd> 1044 <dd>
967 context of extracted docstring (DocStyleContext) 1045 context of extracted docstring
1046 </dd>
1047 </dl>
1048 <dl>
1049 <dt>Return Type:</dt>
1050 <dd>
1051 DocStyleContext
968 </dd> 1052 </dd>
969 </dl> 1053 </dl>
970 <a NAME="DocStyleChecker.__parseFunctions" ID="DocStyleChecker.__parseFunctions"></a> 1054 <a NAME="DocStyleChecker.__parseFunctions" ID="DocStyleChecker.__parseFunctions"></a>
971 <h4>DocStyleChecker.__parseFunctions</h4> 1055 <h4>DocStyleChecker.__parseFunctions</h4>
972 <b>__parseFunctions</b>(<i></i>) 1056 <b>__parseFunctions</b>(<i></i>)
975 Private method to extract top-level functions. 1059 Private method to extract top-level functions.
976 </p> 1060 </p>
977 <dl> 1061 <dl>
978 <dt>Return:</dt> 1062 <dt>Return:</dt>
979 <dd> 1063 <dd>
980 extracted function contexts (list of DocStyleContext) 1064 extracted function contexts
1065 </dd>
1066 </dl>
1067 <dl>
1068 <dt>Return Type:</dt>
1069 <dd>
1070 list of DocStyleContext
981 </dd> 1071 </dd>
982 </dl> 1072 </dl>
983 <a NAME="DocStyleChecker.__parseMethods" ID="DocStyleChecker.__parseMethods"></a> 1073 <a NAME="DocStyleChecker.__parseMethods" ID="DocStyleChecker.__parseMethods"></a>
984 <h4>DocStyleChecker.__parseMethods</h4> 1074 <h4>DocStyleChecker.__parseMethods</h4>
985 <b>__parseMethods</b>(<i></i>) 1075 <b>__parseMethods</b>(<i></i>)
988 Private method to extract methods of all classes. 1078 Private method to extract methods of all classes.
989 </p> 1079 </p>
990 <dl> 1080 <dl>
991 <dt>Return:</dt> 1081 <dt>Return:</dt>
992 <dd> 1082 <dd>
993 extracted method contexts (list of DocStyleContext) 1083 extracted method contexts
1084 </dd>
1085 </dl>
1086 <dl>
1087 <dt>Return Type:</dt>
1088 <dd>
1089 list of DocStyleContext
994 </dd> 1090 </dd>
995 </dl> 1091 </dl>
996 <a NAME="DocStyleChecker.__parseModuleDocstring" ID="DocStyleChecker.__parseModuleDocstring"></a> 1092 <a NAME="DocStyleChecker.__parseModuleDocstring" ID="DocStyleChecker.__parseModuleDocstring"></a>
997 <h4>DocStyleChecker.__parseModuleDocstring</h4> 1093 <h4>DocStyleChecker.__parseModuleDocstring</h4>
998 <b>__parseModuleDocstring</b>(<i>source</i>) 1094 <b>__parseModuleDocstring</b>(<i>source</i>)
1000 <p> 1096 <p>
1001 Private method to extract a docstring given a module source. 1097 Private method to extract a docstring given a module source.
1002 </p> 1098 </p>
1003 <dl> 1099 <dl>
1004 1100
1005 <dt><i>source</i></dt> 1101 <dt><i>source</i> (list of str)</dt>
1006 <dd> 1102 <dd>
1007 source to parse (list of string) 1103 source to parse
1008 </dd> 1104 </dd>
1009 </dl> 1105 </dl>
1010 <dl> 1106 <dl>
1011 <dt>Return:</dt> 1107 <dt>Return:</dt>
1012 <dd> 1108 <dd>
1013 context of extracted docstring (DocStyleContext) 1109 context of extracted docstring
1110 </dd>
1111 </dl>
1112 <dl>
1113 <dt>Return Type:</dt>
1114 <dd>
1115 DocStyleContext
1014 </dd> 1116 </dd>
1015 </dl> 1117 </dl>
1016 <a NAME="DocStyleChecker.__parseTopLevel" ID="DocStyleChecker.__parseTopLevel"></a> 1118 <a NAME="DocStyleChecker.__parseTopLevel" ID="DocStyleChecker.__parseTopLevel"></a>
1017 <h4>DocStyleChecker.__parseTopLevel</h4> 1119 <h4>DocStyleChecker.__parseTopLevel</h4>
1018 <b>__parseTopLevel</b>(<i>keyword</i>) 1120 <b>__parseTopLevel</b>(<i>keyword</i>)
1020 <p> 1122 <p>
1021 Private method to extract top-level functions or classes. 1123 Private method to extract top-level functions or classes.
1022 </p> 1124 </p>
1023 <dl> 1125 <dl>
1024 1126
1025 <dt><i>keyword</i></dt> 1127 <dt><i>keyword</i> (str)</dt>
1026 <dd> 1128 <dd>
1027 keyword signaling what to extract (string) 1129 keyword signaling what to extract
1028 </dd> 1130 </dd>
1029 </dl> 1131 </dl>
1030 <dl> 1132 <dl>
1031 <dt>Return:</dt> 1133 <dt>Return:</dt>
1032 <dd> 1134 <dd>
1033 extracted function or class contexts (list of DocStyleContext) 1135 extracted function or class contexts
1136 </dd>
1137 </dl>
1138 <dl>
1139 <dt>Return Type:</dt>
1140 <dd>
1141 list of DocStyleContext
1034 </dd> 1142 </dd>
1035 </dl> 1143 </dl>
1036 <a NAME="DocStyleChecker.__readline" ID="DocStyleChecker.__readline"></a> 1144 <a NAME="DocStyleChecker.__readline" ID="DocStyleChecker.__readline"></a>
1037 <h4>DocStyleChecker.__readline</h4> 1145 <h4>DocStyleChecker.__readline</h4>
1038 <b>__readline</b>(<i></i>) 1146 <b>__readline</b>(<i></i>)
1041 Private method to get the next line from the source. 1149 Private method to get the next line from the source.
1042 </p> 1150 </p>
1043 <dl> 1151 <dl>
1044 <dt>Return:</dt> 1152 <dt>Return:</dt>
1045 <dd> 1153 <dd>
1046 next line of source (string) 1154 next line of source
1155 </dd>
1156 </dl>
1157 <dl>
1158 <dt>Return Type:</dt>
1159 <dd>
1160 str
1047 </dd> 1161 </dd>
1048 </dl> 1162 </dl>
1049 <a NAME="DocStyleChecker.__resetReadline" ID="DocStyleChecker.__resetReadline"></a> 1163 <a NAME="DocStyleChecker.__resetReadline" ID="DocStyleChecker.__resetReadline"></a>
1050 <h4>DocStyleChecker.__resetReadline</h4> 1164 <h4>DocStyleChecker.__resetReadline</h4>
1051 <b>__resetReadline</b>(<i></i>) 1165 <b>__resetReadline</b>(<i></i>)
1060 <p> 1174 <p>
1061 Private method to skip over an indented block of source code. 1175 Private method to skip over an indented block of source code.
1062 </p> 1176 </p>
1063 <dl> 1177 <dl>
1064 1178
1065 <dt><i>tokenGenerator</i></dt> 1179 <dt><i>tokenGenerator</i> (str iterator)</dt>
1066 <dd> 1180 <dd>
1067 token generator 1181 token generator
1068 </dd> 1182 </dd>
1069 </dl> 1183 </dl>
1070 <dl> 1184 <dl>
1071 <dt>Return:</dt> 1185 <dt>Return:</dt>
1072 <dd> 1186 <dd>
1073 last token of the indented block 1187 last token of the indented block
1188 </dd>
1189 </dl>
1190 <dl>
1191 <dt>Return Type:</dt>
1192 <dd>
1193 tuple
1074 </dd> 1194 </dd>
1075 </dl> 1195 </dl>
1076 <a NAME="DocStyleChecker.run" ID="DocStyleChecker.run"></a> 1196 <a NAME="DocStyleChecker.run" ID="DocStyleChecker.run"></a>
1077 <h4>DocStyleChecker.run</h4> 1197 <h4>DocStyleChecker.run</h4>
1078 <b>run</b>(<i></i>) 1198 <b>run</b>(<i></i>)
1156 <p> 1276 <p>
1157 Constructor 1277 Constructor
1158 </p> 1278 </p>
1159 <dl> 1279 <dl>
1160 1280
1161 <dt><i>source</i></dt> 1281 <dt><i>source</i> (list of str or str)</dt>
1162 <dd> 1282 <dd>
1163 source code of the context (list of string or string) 1283 source code of the context
1164 </dd> 1284 </dd>
1165 <dt><i>startLine</i></dt> 1285 <dt><i>startLine</i> (int)</dt>
1166 <dd> 1286 <dd>
1167 line number the context starts in the source (integer) 1287 line number the context starts in the source
1168 </dd> 1288 </dd>
1169 <dt><i>contextType</i></dt> 1289 <dt><i>contextType</i> (str)</dt>
1170 <dd> 1290 <dd>
1171 type of the context object (string) 1291 type of the context object
1172 </dd> 1292 </dd>
1173 </dl> 1293 </dl>
1174 <a NAME="DocStyleContext.contextType" ID="DocStyleContext.contextType"></a> 1294 <a NAME="DocStyleContext.contextType" ID="DocStyleContext.contextType"></a>
1175 <h4>DocStyleContext.contextType</h4> 1295 <h4>DocStyleContext.contextType</h4>
1176 <b>contextType</b>(<i></i>) 1296 <b>contextType</b>(<i></i>)
1179 Public method to get the context type. 1299 Public method to get the context type.
1180 </p> 1300 </p>
1181 <dl> 1301 <dl>
1182 <dt>Return:</dt> 1302 <dt>Return:</dt>
1183 <dd> 1303 <dd>
1184 context type (string) 1304 context type
1305 </dd>
1306 </dl>
1307 <dl>
1308 <dt>Return Type:</dt>
1309 <dd>
1310 str
1185 </dd> 1311 </dd>
1186 </dl> 1312 </dl>
1187 <a NAME="DocStyleContext.end" ID="DocStyleContext.end"></a> 1313 <a NAME="DocStyleContext.end" ID="DocStyleContext.end"></a>
1188 <h4>DocStyleContext.end</h4> 1314 <h4>DocStyleContext.end</h4>
1189 <b>end</b>(<i></i>) 1315 <b>end</b>(<i></i>)
1192 Public method to get the end line number. 1318 Public method to get the end line number.
1193 </p> 1319 </p>
1194 <dl> 1320 <dl>
1195 <dt>Return:</dt> 1321 <dt>Return:</dt>
1196 <dd> 1322 <dd>
1197 end line number (integer) 1323 end line number
1324 </dd>
1325 </dl>
1326 <dl>
1327 <dt>Return Type:</dt>
1328 <dd>
1329 int
1198 </dd> 1330 </dd>
1199 </dl> 1331 </dl>
1200 <a NAME="DocStyleContext.indent" ID="DocStyleContext.indent"></a> 1332 <a NAME="DocStyleContext.indent" ID="DocStyleContext.indent"></a>
1201 <h4>DocStyleContext.indent</h4> 1333 <h4>DocStyleContext.indent</h4>
1202 <b>indent</b>(<i></i>) 1334 <b>indent</b>(<i></i>)
1205 Public method to get the indentation of the first line. 1337 Public method to get the indentation of the first line.
1206 </p> 1338 </p>
1207 <dl> 1339 <dl>
1208 <dt>Return:</dt> 1340 <dt>Return:</dt>
1209 <dd> 1341 <dd>
1210 indentation string (string) 1342 indentation string
1343 </dd>
1344 </dl>
1345 <dl>
1346 <dt>Return Type:</dt>
1347 <dd>
1348 str
1211 </dd> 1349 </dd>
1212 </dl> 1350 </dl>
1213 <a NAME="DocStyleContext.setSpecial" ID="DocStyleContext.setSpecial"></a> 1351 <a NAME="DocStyleContext.setSpecial" ID="DocStyleContext.setSpecial"></a>
1214 <h4>DocStyleContext.setSpecial</h4> 1352 <h4>DocStyleContext.setSpecial</h4>
1215 <b>setSpecial</b>(<i>special</i>) 1353 <b>setSpecial</b>(<i>special</i>)
1232 Public method to get the source. 1370 Public method to get the source.
1233 </p> 1371 </p>
1234 <dl> 1372 <dl>
1235 <dt>Return:</dt> 1373 <dt>Return:</dt>
1236 <dd> 1374 <dd>
1237 source (list of string) 1375 source
1376 </dd>
1377 </dl>
1378 <dl>
1379 <dt>Return Type:</dt>
1380 <dd>
1381 list of str
1238 </dd> 1382 </dd>
1239 </dl> 1383 </dl>
1240 <a NAME="DocStyleContext.special" ID="DocStyleContext.special"></a> 1384 <a NAME="DocStyleContext.special" ID="DocStyleContext.special"></a>
1241 <h4>DocStyleContext.special</h4> 1385 <h4>DocStyleContext.special</h4>
1242 <b>special</b>(<i></i>) 1386 <b>special</b>(<i></i>)
1264 Public method to get the joined source lines. 1408 Public method to get the joined source lines.
1265 </p> 1409 </p>
1266 <dl> 1410 <dl>
1267 <dt>Return:</dt> 1411 <dt>Return:</dt>
1268 <dd> 1412 <dd>
1269 source (string) 1413 source
1414 </dd>
1415 </dl>
1416 <dl>
1417 <dt>Return Type:</dt>
1418 <dd>
1419 str
1270 </dd> 1420 </dd>
1271 </dl> 1421 </dl>
1272 <a NAME="DocStyleContext.start" ID="DocStyleContext.start"></a> 1422 <a NAME="DocStyleContext.start" ID="DocStyleContext.start"></a>
1273 <h4>DocStyleContext.start</h4> 1423 <h4>DocStyleContext.start</h4>
1274 <b>start</b>(<i></i>) 1424 <b>start</b>(<i></i>)
1277 Public method to get the start line number. 1427 Public method to get the start line number.
1278 </p> 1428 </p>
1279 <dl> 1429 <dl>
1280 <dt>Return:</dt> 1430 <dt>Return:</dt>
1281 <dd> 1431 <dd>
1282 start line number (integer) 1432 start line number
1433 </dd>
1434 </dl>
1435 <dl>
1436 <dt>Return Type:</dt>
1437 <dd>
1438 int
1283 </dd> 1439 </dd>
1284 </dl> 1440 </dl>
1285 <div align="right"><a href="#top">Up</a></div> 1441 <div align="right"><a href="#top">Up</a></div>
1286 <hr /> 1442 <hr />
1287 </body></html> 1443 </body></html>

Mercurial Repository: eric

eric ide

mercurial