Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html

changeset 2938
42d82e978d27
parent 2925
04896af1b0e1
child 2966
f85f686981ad
equal deleted inserted replaced
2937:de26bc76d6ee 2938:42d82e978d27
83 </tr><tr> 83 </tr><tr>
84 <td><a href="#Pep8Fixer.__fixD121">__fixD121</a></td> 84 <td><a href="#Pep8Fixer.__fixD121">__fixD121</a></td>
85 <td>Private method to fix a single line docstring on multiple lines (D121).</td> 85 <td>Private method to fix a single line docstring on multiple lines (D121).</td>
86 </tr><tr> 86 </tr><tr>
87 <td><a href="#Pep8Fixer.__fixD131">__fixD131</a></td> 87 <td><a href="#Pep8Fixer.__fixD131">__fixD131</a></td>
88 <td>Private method to fix a single line docstring on multiple lines (D121).</td> 88 <td>Private method to fix a docstring summary not ending with a period (D131).</td>
89 </tr><tr> 89 </tr><tr>
90 <td><a href="#Pep8Fixer.__fixD141">__fixD141</a></td> 90 <td><a href="#Pep8Fixer.__fixD141">__fixD141</a></td>
91 <td>Private method to fix a function/method docstring preceded by a blank line (D141).</td> 91 <td>Private method to fix a function/method docstring preceded by a blank line (D141).</td>
92 </tr><tr> 92 </tr><tr>
93 <td><a href="#Pep8Fixer.__fixD142">__fixD142</a></td> 93 <td><a href="#Pep8Fixer.__fixD142">__fixD142</a></td>
99 <td><a href="#Pep8Fixer.__fixD144">__fixD144</a></td> 99 <td><a href="#Pep8Fixer.__fixD144">__fixD144</a></td>
100 <td>Private method to fix a docstring summary not followed by a blank line (D144).</td> 100 <td>Private method to fix a docstring summary not followed by a blank line (D144).</td>
101 </tr><tr> 101 </tr><tr>
102 <td><a href="#Pep8Fixer.__fixD145">__fixD145</a></td> 102 <td><a href="#Pep8Fixer.__fixD145">__fixD145</a></td>
103 <td>Private method to fix the last paragraph of a multi-line docstring not followed by a blank line (D143).</td> 103 <td>Private method to fix the last paragraph of a multi-line docstring not followed by a blank line (D143).</td>
104 </tr><tr>
105 <td><a href="#Pep8Fixer.__fixD221">__fixD221</a></td>
106 <td>Private method to fix leading and trailing quotes of docstring not on separate lines (D221, D222).</td>
107 </tr><tr>
108 <td><a href="#Pep8Fixer.__fixD242">__fixD242</a></td>
109 <td>Private method to fix a class or function/method docstring preceded by a blank line (D242, D244).</td>
110 </tr><tr>
111 <td><a href="#Pep8Fixer.__fixD243">__fixD243</a></td>
112 <td>Private method to fix a class or function/method docstring followed by a blank line (D243, D245).</td>
113 </tr><tr>
114 <td><a href="#Pep8Fixer.__fixD247">__fixD247</a></td>
115 <td>Private method to fix a last paragraph of a docstring followed by a blank line (D247).</td>
104 </tr><tr> 116 </tr><tr>
105 <td><a href="#Pep8Fixer.__fixE101">__fixE101</a></td> 117 <td><a href="#Pep8Fixer.__fixE101">__fixE101</a></td>
106 <td>Private method to fix obsolete tab usage and indentation errors (E101, E111, W191).</td> 118 <td>Private method to fix obsolete tab usage and indentation errors (E101, E111, W191).</td>
107 </tr><tr> 119 </tr><tr>
108 <td><a href="#Pep8Fixer.__fixE121">__fixE121</a></td> 120 <td><a href="#Pep8Fixer.__fixE121">__fixE121</a></td>
361 </dd> 373 </dd>
362 </dl><a NAME="Pep8Fixer.__fixD131" ID="Pep8Fixer.__fixD131"></a> 374 </dl><a NAME="Pep8Fixer.__fixD131" ID="Pep8Fixer.__fixD131"></a>
363 <h4>Pep8Fixer.__fixD131</h4> 375 <h4>Pep8Fixer.__fixD131</h4>
364 <b>__fixD131</b>(<i>code, line, pos</i>) 376 <b>__fixD131</b>(<i>code, line, pos</i>)
365 <p> 377 <p>
366 Private method to fix a single line docstring on multiple lines (D121). 378 Private method to fix a docstring summary not ending with a
379 period (D131).
367 </p><dl> 380 </p><dl>
368 <dt><i>code</i></dt> 381 <dt><i>code</i></dt>
369 <dd> 382 <dd>
370 code of the issue (string) 383 code of the issue (string)
371 </dd><dt><i>line</i></dt> 384 </dd><dt><i>line</i></dt>
498 <h4>Pep8Fixer.__fixD145</h4> 511 <h4>Pep8Fixer.__fixD145</h4>
499 <b>__fixD145</b>(<i>code, line, pos, apply=False</i>) 512 <b>__fixD145</b>(<i>code, line, pos, apply=False</i>)
500 <p> 513 <p>
501 Private method to fix the last paragraph of a multi-line docstring 514 Private method to fix the last paragraph of a multi-line docstring
502 not followed by a blank line (D143). 515 not followed by a blank line (D143).
516 </p><dl>
517 <dt><i>code</i></dt>
518 <dd>
519 code of the issue (string)
520 </dd><dt><i>line</i></dt>
521 <dd>
522 line number of the issue (integer)
523 </dd><dt><i>pos</i></dt>
524 <dd>
525 position inside line (integer)
526 </dd><dt><i>apply=</i></dt>
527 <dd>
528 flag indicating, that the fix should be applied
529 (boolean)
530 </dd>
531 </dl><dl>
532 <dt>Returns:</dt>
533 <dd>
534 value indicating an applied/deferred fix (-1, 0, 1),
535 a message for the fix (string) and an ID for a deferred
536 fix (integer)
537 </dd>
538 </dl><a NAME="Pep8Fixer.__fixD221" ID="Pep8Fixer.__fixD221"></a>
539 <h4>Pep8Fixer.__fixD221</h4>
540 <b>__fixD221</b>(<i>code, line, pos, apply=False</i>)
541 <p>
542 Private method to fix leading and trailing quotes of docstring
543 not on separate lines (D221, D222).
544 </p><dl>
545 <dt><i>code</i></dt>
546 <dd>
547 code of the issue (string)
548 </dd><dt><i>line</i></dt>
549 <dd>
550 line number of the issue (integer)
551 </dd><dt><i>pos</i></dt>
552 <dd>
553 position inside line (integer)
554 </dd><dt><i>apply=</i></dt>
555 <dd>
556 flag indicating, that the fix should be applied
557 (boolean)
558 </dd>
559 </dl><dl>
560 <dt>Returns:</dt>
561 <dd>
562 value indicating an applied/deferred fix (-1, 0, 1),
563 a message for the fix (string) and an ID for a deferred
564 fix (integer)
565 </dd>
566 </dl><a NAME="Pep8Fixer.__fixD242" ID="Pep8Fixer.__fixD242"></a>
567 <h4>Pep8Fixer.__fixD242</h4>
568 <b>__fixD242</b>(<i>code, line, pos, apply=False</i>)
569 <p>
570 Private method to fix a class or function/method docstring preceded
571 by a blank line (D242, D244).
572 </p><dl>
573 <dt><i>code</i></dt>
574 <dd>
575 code of the issue (string)
576 </dd><dt><i>line</i></dt>
577 <dd>
578 line number of the issue (integer)
579 </dd><dt><i>pos</i></dt>
580 <dd>
581 position inside line (integer)
582 </dd><dt><i>apply=</i></dt>
583 <dd>
584 flag indicating, that the fix should be applied
585 (boolean)
586 </dd>
587 </dl><dl>
588 <dt>Returns:</dt>
589 <dd>
590 value indicating an applied/deferred fix (-1, 0, 1),
591 a message for the fix (string) and an ID for a deferred
592 fix (integer)
593 </dd>
594 </dl><a NAME="Pep8Fixer.__fixD243" ID="Pep8Fixer.__fixD243"></a>
595 <h4>Pep8Fixer.__fixD243</h4>
596 <b>__fixD243</b>(<i>code, line, pos, apply=False</i>)
597 <p>
598 Private method to fix a class or function/method docstring followed
599 by a blank line (D243, D245).
600 </p><dl>
601 <dt><i>code</i></dt>
602 <dd>
603 code of the issue (string)
604 </dd><dt><i>line</i></dt>
605 <dd>
606 line number of the issue (integer)
607 </dd><dt><i>pos</i></dt>
608 <dd>
609 position inside line (integer)
610 </dd><dt><i>apply=</i></dt>
611 <dd>
612 flag indicating, that the fix should be applied
613 (boolean)
614 </dd>
615 </dl><dl>
616 <dt>Returns:</dt>
617 <dd>
618 value indicating an applied/deferred fix (-1, 0, 1),
619 a message for the fix (string) and an ID for a deferred
620 fix (integer)
621 </dd>
622 </dl><a NAME="Pep8Fixer.__fixD247" ID="Pep8Fixer.__fixD247"></a>
623 <h4>Pep8Fixer.__fixD247</h4>
624 <b>__fixD247</b>(<i>code, line, pos, apply=False</i>)
625 <p>
626 Private method to fix a last paragraph of a docstring followed
627 by a blank line (D247).
503 </p><dl> 628 </p><dl>
504 <dt><i>code</i></dt> 629 <dt><i>code</i></dt>
505 <dd> 630 <dd>
506 code of the issue (string) 631 code of the issue (string)
507 </dd><dt><i>line</i></dt> 632 </dd><dt><i>line</i></dt>

eric ide

mercurial