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

branch
eric7
changeset 10684
58c7f23ae1cb
parent 10479
856476537696
child 11150
73d80859079c
equal deleted inserted replaced
10683:779cda568acb 10684:58c7f23ae1cb
293 type of the documentation strings (one of 'eric' or 'pep257') 293 type of the documentation strings (one of 'eric' or 'pep257')
294 </dd> 294 </dd>
295 </dl> 295 </dl>
296 <a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a> 296 <a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a>
297 <h4>DocStyleChecker.__checkBackslashes</h4> 297 <h4>DocStyleChecker.__checkBackslashes</h4>
298 <b>__checkBackslashes</b>(<i>docstringContext, context</i>) 298 <b>__checkBackslashes</b>(<i>docstringContext, _context</i>)
299 <p> 299 <p>
300 Private method to check, that all docstrings containing 300 Private method to check, that all docstrings containing
301 backslashes are surrounded by raw triple double quotes. 301 backslashes are surrounded by raw triple double quotes.
302 </p> 302 </p>
303 303
305 305
306 <dt><i>docstringContext</i> (DocStyleContext)</dt> 306 <dt><i>docstringContext</i> (DocStyleContext)</dt>
307 <dd> 307 <dd>
308 docstring context 308 docstring context
309 </dd> 309 </dd>
310 <dt><i>context</i> (DocStyleContext)</dt> 310 <dt><i>_context</i> (DocStyleContext)</dt>
311 <dd> 311 <dd>
312 context of the docstring 312 context of the docstring (unused)
313 </dd> 313 </dd>
314 </dl> 314 </dl>
315 <a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a> 315 <a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a>
316 <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4> 316 <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4>
317 <b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) 317 <b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, _context</i>)
318 <p> 318 <p>
319 Private method to check, that the last paragraph of docstrings is 319 Private method to check, that the last paragraph of docstrings is
320 followed by a blank line. 320 followed by a blank line.
321 </p> 321 </p>
322 322
324 324
325 <dt><i>docstringContext</i> (DocStyleContext)</dt> 325 <dt><i>docstringContext</i> (DocStyleContext)</dt>
326 <dd> 326 <dd>
327 docstring context 327 docstring context
328 </dd> 328 </dd>
329 <dt><i>context</i> (DocStyleContext)</dt> 329 <dt><i>_context</i> (DocStyleContext)</dt>
330 <dd> 330 <dd>
331 context of the docstring 331 context of the docstring (unused)
332 </dd> 332 </dd>
333 </dl> 333 </dl>
334 <a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a> 334 <a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a>
335 <h4>DocStyleChecker.__checkBlankAfterSummary</h4> 335 <h4>DocStyleChecker.__checkBlankAfterSummary</h4>
336 <b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>) 336 <b>__checkBlankAfterSummary</b>(<i>docstringContext, _context</i>)
337 <p> 337 <p>
338 Private method to check, that docstring summaries are followed 338 Private method to check, that docstring summaries are followed
339 by a blank line. 339 by a blank line.
340 </p> 340 </p>
341 341
343 343
344 <dt><i>docstringContext</i> (DocStyleContext)</dt> 344 <dt><i>docstringContext</i> (DocStyleContext)</dt>
345 <dd> 345 <dd>
346 docstring context 346 docstring context
347 </dd> 347 </dd>
348 <dt><i>context</i> (DocStyleContext)</dt> 348 <dt><i>_context</i> (DocStyleContext)</dt>
349 <dd> 349 <dd>
350 context of the docstring 350 context of the docstring (unused)
351 </dd> 351 </dd>
352 </dl> 352 </dl>
353 <a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a> 353 <a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a>
354 <h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4> 354 <h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4>
355 <b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) 355 <b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>)
388 context of the docstring 388 context of the docstring
389 </dd> 389 </dd>
390 </dl> 390 </dl>
391 <a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a> 391 <a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a>
392 <h4>DocStyleChecker.__checkEndsWithPeriod</h4> 392 <h4>DocStyleChecker.__checkEndsWithPeriod</h4>
393 <b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>) 393 <b>__checkEndsWithPeriod</b>(<i>docstringContext, _context</i>)
394 <p> 394 <p>
395 Private method to check, that docstring summaries end with a period. 395 Private method to check, that docstring summaries end with a period.
396 </p> 396 </p>
397 397
398 <dl> 398 <dl>
399 399
400 <dt><i>docstringContext</i> (DocStyleContext)</dt> 400 <dt><i>docstringContext</i> (DocStyleContext)</dt>
401 <dd> 401 <dd>
402 docstring context 402 docstring context
403 </dd> 403 </dd>
404 <dt><i>context</i> (DocStyleContext)</dt> 404 <dt><i>_context</i> (DocStyleContext)</dt>
405 <dd> 405 <dd>
406 context of the docstring 406 context of the docstring (unused)
407 </dd> 407 </dd>
408 </dl> 408 </dl>
409 <a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a> 409 <a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a>
410 <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4> 410 <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4>
411 <b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>) 411 <b>__checkEricBlankAfterSummary</b>(<i>docstringContext, _context</i>)
412 <p> 412 <p>
413 Private method to check, that docstring summaries are followed 413 Private method to check, that docstring summaries are followed
414 by a blank line. 414 by a blank line.
415 </p> 415 </p>
416 416
418 418
419 <dt><i>docstringContext</i> (DocStyleContext)</dt> 419 <dt><i>docstringContext</i> (DocStyleContext)</dt>
420 <dd> 420 <dd>
421 docstring context 421 docstring context
422 </dd> 422 </dd>
423 <dt><i>context</i> (DocStyleContext)</dt> 423 <dt><i>_context</i> (DocStyleContext)</dt>
424 <dd> 424 <dd>
425 context of the docstring 425 context of the docstring (unused)
426 </dd> 426 </dd>
427 </dl> 427 </dl>
428 <a NAME="DocStyleChecker.__checkEricDocumentationDeprecatedTags" ID="DocStyleChecker.__checkEricDocumentationDeprecatedTags"></a> 428 <a NAME="DocStyleChecker.__checkEricDocumentationDeprecatedTags" ID="DocStyleChecker.__checkEricDocumentationDeprecatedTags"></a>
429 <h4>DocStyleChecker.__checkEricDocumentationDeprecatedTags</h4> 429 <h4>DocStyleChecker.__checkEricDocumentationDeprecatedTags</h4>
430 <b>__checkEricDocumentationDeprecatedTags</b>(<i>docstringContext, context, </i>) 430 <b>__checkEricDocumentationDeprecatedTags</b>(<i>docstringContext, _context, </i>)
431 <p> 431 <p>
432 Private method to check the use of deprecated documentation tags. 432 Private method to check the use of deprecated documentation tags.
433 </p> 433 </p>
434 434
435 <dl> 435 <dl>
436 436
437 <dt><i>docstringContext</i> (DocStyleContext)</dt> 437 <dt><i>docstringContext</i> (DocStyleContext)</dt>
438 <dd> 438 <dd>
439 docstring context 439 docstring context
440 </dd> 440 </dd>
441 <dt><i>context</i> (DocStyleContext)</dt> 441 <dt><i>_context</i> (DocStyleContext)</dt>
442 <dd> 442 <dd>
443 context of the docstring 443 context of the docstring (unused)
444 </dd> 444 </dd>
445 </dl> 445 </dl>
446 <a NAME="DocStyleChecker.__checkEricDocumentationIndent" ID="DocStyleChecker.__checkEricDocumentationIndent"></a> 446 <a NAME="DocStyleChecker.__checkEricDocumentationIndent" ID="DocStyleChecker.__checkEricDocumentationIndent"></a>
447 <h4>DocStyleChecker.__checkEricDocumentationIndent</h4> 447 <h4>DocStyleChecker.__checkEricDocumentationIndent</h4>
448 <b>__checkEricDocumentationIndent</b>(<i>docstringContext, context, </i>) 448 <b>__checkEricDocumentationIndent</b>(<i>docstringContext, _context, </i>)
449 <p> 449 <p>
450 Private method to check the the correct indentation of the tag lines. 450 Private method to check the the correct indentation of the tag lines.
451 </p> 451 </p>
452 452
453 <dl> 453 <dl>
454 454
455 <dt><i>docstringContext</i> (DocStyleContext)</dt> 455 <dt><i>docstringContext</i> (DocStyleContext)</dt>
456 <dd> 456 <dd>
457 docstring context 457 docstring context
458 </dd> 458 </dd>
459 <dt><i>context</i> (DocStyleContext)</dt> 459 <dt><i>_context</i> (DocStyleContext)</dt>
460 <dd> 460 <dd>
461 context of the docstring 461 context of the docstring (unused)
462 </dd> 462 </dd>
463 </dl> 463 </dl>
464 <a NAME="DocStyleChecker.__checkEricDocumentationSequence" ID="DocStyleChecker.__checkEricDocumentationSequence"></a> 464 <a NAME="DocStyleChecker.__checkEricDocumentationSequence" ID="DocStyleChecker.__checkEricDocumentationSequence"></a>
465 <h4>DocStyleChecker.__checkEricDocumentationSequence</h4> 465 <h4>DocStyleChecker.__checkEricDocumentationSequence</h4>
466 <b>__checkEricDocumentationSequence</b>(<i>docstringContext, context, </i>) 466 <b>__checkEricDocumentationSequence</b>(<i>docstringContext, _context, </i>)
467 <p> 467 <p>
468 Private method to check, that method docstring follows the correct sequence 468 Private method to check, that method docstring follows the correct sequence
469 of entries (e.g. @param is followed by @type). 469 of entries (e.g. @param is followed by @type).
470 </p> 470 </p>
471 471
473 473
474 <dt><i>docstringContext</i> (DocStyleContext)</dt> 474 <dt><i>docstringContext</i> (DocStyleContext)</dt>
475 <dd> 475 <dd>
476 docstring context 476 docstring context
477 </dd> 477 </dd>
478 <dt><i>context</i> (DocStyleContext)</dt> 478 <dt><i>_context</i> (DocStyleContext)</dt>
479 <dd> 479 <dd>
480 context of the docstring 480 context of the docstring (unused)
481 </dd> 481 </dd>
482 </dl> 482 </dl>
483 <a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a> 483 <a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a>
484 <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4> 484 <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4>
485 <b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>) 485 <b>__checkEricEndsWithPeriod</b>(<i>docstringContext, _context</i>)
486 <p> 486 <p>
487 Private method to check, that docstring summaries end with a period. 487 Private method to check, that docstring summaries end with a period.
488 </p> 488 </p>
489 489
490 <dl> 490 <dl>
491 491
492 <dt><i>docstringContext</i> (DocStyleContext)</dt> 492 <dt><i>docstringContext</i> (DocStyleContext)</dt>
493 <dd> 493 <dd>
494 docstring context 494 docstring context
495 </dd> 495 </dd>
496 <dt><i>context</i> (DocStyleContext)</dt> 496 <dt><i>_context</i> (DocStyleContext)</dt>
497 <dd> 497 <dd>
498 context of the docstring 498 context of the docstring (unused)
499 </dd> 499 </dd>
500 </dl> 500 </dl>
501 <a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a> 501 <a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a>
502 <h4>DocStyleChecker.__checkEricException</h4> 502 <h4>DocStyleChecker.__checkEricException</h4>
503 <b>__checkEricException</b>(<i>docstringContext, context</i>) 503 <b>__checkEricException</b>(<i>docstringContext, context</i>)
541 context of the docstring 541 context of the docstring
542 </dd> 542 </dd>
543 </dl> 543 </dl>
544 <a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a> 544 <a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a>
545 <h4>DocStyleChecker.__checkEricNBlankAfterLastParagraph</h4> 545 <h4>DocStyleChecker.__checkEricNBlankAfterLastParagraph</h4>
546 <b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) 546 <b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, _context</i>)
547 <p> 547 <p>
548 Private method to check, that the last paragraph of docstrings is 548 Private method to check, that the last paragraph of docstrings is
549 not followed by a blank line. 549 not followed by a blank line.
550 </p> 550 </p>
551 551
553 553
554 <dt><i>docstringContext</i> (DocStyleContext)</dt> 554 <dt><i>docstringContext</i> (DocStyleContext)</dt>
555 <dd> 555 <dd>
556 docstring context 556 docstring context
557 </dd> 557 </dd>
558 <dt><i>context</i> (DocStyleContext)</dt> 558 <dt><i>_context</i> (DocStyleContext)</dt>
559 <dd> 559 <dd>
560 context of the docstring 560 context of the docstring (unused)
561 </dd> 561 </dd>
562 </dl> 562 </dl>
563 <a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> 563 <a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a>
564 <h4>DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4> 564 <h4>DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4>
565 <b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>) 565 <b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>)
579 context of the docstring 579 context of the docstring
580 </dd> 580 </dd>
581 </dl> 581 </dl>
582 <a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a> 582 <a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a>
583 <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4> 583 <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4>
584 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) 584 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, _context</i>)
585 <p> 585 <p>
586 Private method to check, that leading and trailing quotes are on 586 Private method to check, that leading and trailing quotes are on
587 a line by themselves. 587 a line by themselves.
588 </p> 588 </p>
589 589
591 591
592 <dt><i>docstringContext</i> (DocStyleContext)</dt> 592 <dt><i>docstringContext</i> (DocStyleContext)</dt>
593 <dd> 593 <dd>
594 docstring context 594 docstring context
595 </dd> 595 </dd>
596 <dt><i>context</i> (DocStyleContext)</dt> 596 <dt><i>_context</i> (DocStyleContext)</dt>
597 <dd> 597 <dd>
598 context of the docstring 598 context of the docstring (unused)
599 </dd> 599 </dd>
600 </dl> 600 </dl>
601 <a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a> 601 <a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a>
602 <h4>DocStyleChecker.__checkEricReturn</h4> 602 <h4>DocStyleChecker.__checkEricReturn</h4>
603 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) 603 <b>__checkEricReturn</b>(<i>docstringContext, context</i>)
698 context of the docstring 698 context of the docstring
699 </dd> 699 </dd>
700 </dl> 700 </dl>
701 <a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a> 701 <a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a>
702 <h4>DocStyleChecker.__checkImperativeMood</h4> 702 <h4>DocStyleChecker.__checkImperativeMood</h4>
703 <b>__checkImperativeMood</b>(<i>docstringContext, context</i>) 703 <b>__checkImperativeMood</b>(<i>docstringContext, _context</i>)
704 <p> 704 <p>
705 Private method to check, that docstring summaries are in 705 Private method to check, that docstring summaries are in
706 imperative mood. 706 imperative mood.
707 </p> 707 </p>
708 708
710 710
711 <dt><i>docstringContext</i> (DocStyleContext)</dt> 711 <dt><i>docstringContext</i> (DocStyleContext)</dt>
712 <dd> 712 <dd>
713 docstring context 713 docstring context
714 </dd> 714 </dd>
715 <dt><i>context</i> (DocStyleContext)</dt> 715 <dt><i>_context</i> (DocStyleContext)</dt>
716 <dd> 716 <dd>
717 context of the docstring 717 context of the docstring (unused)
718 </dd> 718 </dd>
719 </dl> 719 </dl>
720 <a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a> 720 <a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a>
721 <h4>DocStyleChecker.__checkIndent</h4> 721 <h4>DocStyleChecker.__checkIndent</h4>
722 <b>__checkIndent</b>(<i>docstringContext, context</i>) 722 <b>__checkIndent</b>(<i>docstringContext, context</i>)
828 context of the docstring 828 context of the docstring
829 </dd> 829 </dd>
830 </dl> 830 </dl>
831 <a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a> 831 <a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a>
832 <h4>DocStyleChecker.__checkSummary</h4> 832 <h4>DocStyleChecker.__checkSummary</h4>
833 <b>__checkSummary</b>(<i>docstringContext, context</i>) 833 <b>__checkSummary</b>(<i>docstringContext, _context</i>)
834 <p> 834 <p>
835 Private method to check, that docstring summaries contain some text. 835 Private method to check, that docstring summaries contain some text.
836 </p> 836 </p>
837 837
838 <dl> 838 <dl>
839 839
840 <dt><i>docstringContext</i> (DocStyleContext)</dt> 840 <dt><i>docstringContext</i> (DocStyleContext)</dt>
841 <dd> 841 <dd>
842 docstring context 842 docstring context
843 </dd> 843 </dd>
844 <dt><i>context</i> (DocStyleContext)</dt> 844 <dt><i>_context</i> (DocStyleContext)</dt>
845 <dd> 845 <dd>
846 context of the docstring 846 context of the docstring (unused)
847 </dd> 847 </dd>
848 </dl> 848 </dl>
849 <a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a> 849 <a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a>
850 <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4> 850 <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4>
851 <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>) 851 <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, _context</i>)
852 <p> 852 <p>
853 Private method to check, that all docstrings are surrounded 853 Private method to check, that all docstrings are surrounded
854 by triple double quotes. 854 by triple double quotes.
855 </p> 855 </p>
856 856
858 858
859 <dt><i>docstringContext</i> (DocStyleContext)</dt> 859 <dt><i>docstringContext</i> (DocStyleContext)</dt>
860 <dd> 860 <dd>
861 docstring context 861 docstring context
862 </dd> 862 </dd>
863 <dt><i>context</i> (DocStyleContext)</dt> 863 <dt><i>_context</i> (DocStyleContext)</dt>
864 <dd> 864 <dd>
865 context of the docstring 865 context of the docstring (unused)
866 </dd> 866 </dd>
867 </dl> 867 </dl>
868 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> 868 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a>
869 <h4>DocStyleChecker.__error</h4> 869 <h4>DocStyleChecker.__error</h4>
870 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) 870 <b>__error</b>(<i>lineNumber, offset, code, *args</i>)

eric ide

mercurial