Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html

eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html

changeset 7989
a21d673a8f99
parent 7900
72b88fb20261
child 8215
fc5d68a6889e
equal deleted inserted replaced
7988:c4c17121eff8 7989:a21d673a8f99
367 <dd> 367 <dd>
368 to check (string) 368 to check (string)
369 </dd> 369 </dd>
370 </dl> 370 </dl>
371 <dl> 371 <dl>
372 <dt>Returns:</dt> 372 <dt>Return:</dt>
373 <dd> 373 <dd>
374 flag indicating it should be fixed (boolean) 374 flag indicating it should be fixed (boolean)
375 </dd> 375 </dd>
376 </dl> 376 </dl>
377 <a NAME="CodeStyleFixer.__findLogical" ID="CodeStyleFixer.__findLogical"></a> 377 <a NAME="CodeStyleFixer.__findLogical" ID="CodeStyleFixer.__findLogical"></a>
381 <p> 381 <p>
382 Private method to extract the index of all the starts and ends of 382 Private method to extract the index of all the starts and ends of
383 lines. 383 lines.
384 </p> 384 </p>
385 <dl> 385 <dl>
386 <dt>Returns:</dt> 386 <dt>Return:</dt>
387 <dd> 387 <dd>
388 tuple containing two lists of integer with start and end tuples 388 tuple containing two lists of integer with start and end tuples
389 of lines 389 of lines
390 </dd> 390 </dd>
391 </dl> 391 </dl>
418 <dd> 418 <dd>
419 flag indicating, that the fix should be applied 419 flag indicating, that the fix should be applied
420 </dd> 420 </dd>
421 </dl> 421 </dl>
422 <dl> 422 <dl>
423 <dt>Returns:</dt> 423 <dt>Return:</dt>
424 <dd> 424 <dd>
425 value indicating an applied/deferred fix (-1, 0, 1), 425 value indicating an applied/deferred fix (-1, 0, 1),
426 a message code for the fix, a list of arguments for the 426 a message code for the fix, a list of arguments for the
427 message and an ID for a deferred fix 427 message and an ID for a deferred fix
428 </dd> 428 </dd>
457 <dd> 457 <dd>
458 position inside line 458 position inside line
459 </dd> 459 </dd>
460 </dl> 460 </dl>
461 <dl> 461 <dl>
462 <dt>Returns:</dt> 462 <dt>Return:</dt>
463 <dd> 463 <dd>
464 value indicating an applied/deferred fix (-1, 0, 1), 464 value indicating an applied/deferred fix (-1, 0, 1),
465 a message code for the fix, a list of arguments for the 465 a message code for the fix, a list of arguments for the
466 message and an ID for a deferred fix 466 message and an ID for a deferred fix
467 </dd> 467 </dd>
496 <dd> 496 <dd>
497 position inside line 497 position inside line
498 </dd> 498 </dd>
499 </dl> 499 </dl>
500 <dl> 500 <dl>
501 <dt>Returns:</dt> 501 <dt>Return:</dt>
502 <dd> 502 <dd>
503 value indicating an applied/deferred fix (-1, 0, 1), 503 value indicating an applied/deferred fix (-1, 0, 1),
504 a message code for the fix, a list of arguments for the 504 a message code for the fix, a list of arguments for the
505 message and an ID for a deferred fix 505 message and an ID for a deferred fix
506 </dd> 506 </dd>
539 <dd> 539 <dd>
540 flag indicating, that the fix should be applied 540 flag indicating, that the fix should be applied
541 </dd> 541 </dd>
542 </dl> 542 </dl>
543 <dl> 543 <dl>
544 <dt>Returns:</dt> 544 <dt>Return:</dt>
545 <dd> 545 <dd>
546 value indicating an applied/deferred fix (-1, 0, 1), 546 value indicating an applied/deferred fix (-1, 0, 1),
547 a message code for the fix, a list of arguments for the 547 a message code for the fix, a list of arguments for the
548 message and an ID for a deferred fix 548 message and an ID for a deferred fix
549 </dd> 549 </dd>
579 <dd> 579 <dd>
580 position inside line 580 position inside line
581 </dd> 581 </dd>
582 </dl> 582 </dl>
583 <dl> 583 <dl>
584 <dt>Returns:</dt> 584 <dt>Return:</dt>
585 <dd> 585 <dd>
586 value indicating an applied/deferred fix (-1, 0, 1), 586 value indicating an applied/deferred fix (-1, 0, 1),
587 a message code for the fix, a list of arguments for the 587 a message code for the fix, a list of arguments for the
588 message and an ID for a deferred fix 588 message and an ID for a deferred fix
589 </dd> 589 </dd>
623 <dd> 623 <dd>
624 flag indicating, that the fix should be applied 624 flag indicating, that the fix should be applied
625 </dd> 625 </dd>
626 </dl> 626 </dl>
627 <dl> 627 <dl>
628 <dt>Returns:</dt> 628 <dt>Return:</dt>
629 <dd> 629 <dd>
630 value indicating an applied/deferred fix (-1, 0, 1), 630 value indicating an applied/deferred fix (-1, 0, 1),
631 a message code for the fix, a list of arguments for the 631 a message code for the fix, a list of arguments for the
632 message and an ID for a deferred fix 632 message and an ID for a deferred fix
633 </dd> 633 </dd>
667 <dd> 667 <dd>
668 flag indicating, that the fix should be applied 668 flag indicating, that the fix should be applied
669 </dd> 669 </dd>
670 </dl> 670 </dl>
671 <dl> 671 <dl>
672 <dt>Returns:</dt> 672 <dt>Return:</dt>
673 <dd> 673 <dd>
674 value indicating an applied/deferred fix (-1, 0, 1), 674 value indicating an applied/deferred fix (-1, 0, 1),
675 a message code for the fix, a list of arguments for the 675 a message code for the fix, a list of arguments for the
676 message and an ID for a deferred fix 676 message and an ID for a deferred fix
677 </dd> 677 </dd>
711 <dd> 711 <dd>
712 flag indicating, that the fix should be applied 712 flag indicating, that the fix should be applied
713 </dd> 713 </dd>
714 </dl> 714 </dl>
715 <dl> 715 <dl>
716 <dt>Returns:</dt> 716 <dt>Return:</dt>
717 <dd> 717 <dd>
718 value indicating an applied/deferred fix (-1, 0, 1), 718 value indicating an applied/deferred fix (-1, 0, 1),
719 a message code for the fix, a list of arguments for the 719 a message code for the fix, a list of arguments for the
720 message and an ID for a deferred fix 720 message and an ID for a deferred fix
721 </dd> 721 </dd>
755 <dd> 755 <dd>
756 flag indicating, that the fix should be applied 756 flag indicating, that the fix should be applied
757 </dd> 757 </dd>
758 </dl> 758 </dl>
759 <dl> 759 <dl>
760 <dt>Returns:</dt> 760 <dt>Return:</dt>
761 <dd> 761 <dd>
762 value indicating an applied/deferred fix (-1, 0, 1), 762 value indicating an applied/deferred fix (-1, 0, 1),
763 a message code for the fix, a list of arguments for the 763 a message code for the fix, a list of arguments for the
764 message and an ID for a deferred fix 764 message and an ID for a deferred fix
765 </dd> 765 </dd>
799 <dd> 799 <dd>
800 flag indicating, that the fix should be applied 800 flag indicating, that the fix should be applied
801 </dd> 801 </dd>
802 </dl> 802 </dl>
803 <dl> 803 <dl>
804 <dt>Returns:</dt> 804 <dt>Return:</dt>
805 <dd> 805 <dd>
806 value indicating an applied/deferred fix (-1, 0, 1), 806 value indicating an applied/deferred fix (-1, 0, 1),
807 a message code for the fix, a list of arguments for the 807 a message code for the fix, a list of arguments for the
808 message and an ID for a deferred fix 808 message and an ID for a deferred fix
809 </dd> 809 </dd>
843 <dd> 843 <dd>
844 flag indicating, that the fix should be applied 844 flag indicating, that the fix should be applied
845 </dd> 845 </dd>
846 </dl> 846 </dl>
847 <dl> 847 <dl>
848 <dt>Returns:</dt> 848 <dt>Return:</dt>
849 <dd> 849 <dd>
850 value indicating an applied/deferred fix (-1, 0, 1), 850 value indicating an applied/deferred fix (-1, 0, 1),
851 a message code for the fix, a list of arguments for the 851 a message code for the fix, a list of arguments for the
852 message and an ID for a deferred fix 852 message and an ID for a deferred fix
853 </dd> 853 </dd>
887 <dd> 887 <dd>
888 flag indicating, that the fix should be applied 888 flag indicating, that the fix should be applied
889 </dd> 889 </dd>
890 </dl> 890 </dl>
891 <dl> 891 <dl>
892 <dt>Returns:</dt> 892 <dt>Return:</dt>
893 <dd> 893 <dd>
894 value indicating an applied/deferred fix (-1, 0, 1), 894 value indicating an applied/deferred fix (-1, 0, 1),
895 a message code for the fix, a list of arguments for the 895 a message code for the fix, a list of arguments for the
896 message and an ID for a deferred fix 896 message and an ID for a deferred fix
897 </dd> 897 </dd>
931 <dd> 931 <dd>
932 flag indicating, that the fix should be applied 932 flag indicating, that the fix should be applied
933 </dd> 933 </dd>
934 </dl> 934 </dl>
935 <dl> 935 <dl>
936 <dt>Returns:</dt> 936 <dt>Return:</dt>
937 <dd> 937 <dd>
938 value indicating an applied/deferred fix (-1, 0, 1), 938 value indicating an applied/deferred fix (-1, 0, 1),
939 a message code for the fix, a list of arguments for the 939 a message code for the fix, a list of arguments for the
940 message and an ID for a deferred fix 940 message and an ID for a deferred fix
941 </dd> 941 </dd>
975 <dd> 975 <dd>
976 flag indicating, that the fix should be applied 976 flag indicating, that the fix should be applied
977 </dd> 977 </dd>
978 </dl> 978 </dl>
979 <dl> 979 <dl>
980 <dt>Returns:</dt> 980 <dt>Return:</dt>
981 <dd> 981 <dd>
982 value indicating an applied/deferred fix (-1, 0, 1), 982 value indicating an applied/deferred fix (-1, 0, 1),
983 a message code for the fix, a list of arguments for the 983 a message code for the fix, a list of arguments for the
984 message and an ID for a deferred fix 984 message and an ID for a deferred fix
985 </dd> 985 </dd>
1014 <dd> 1014 <dd>
1015 position inside line 1015 position inside line
1016 </dd> 1016 </dd>
1017 </dl> 1017 </dl>
1018 <dl> 1018 <dl>
1019 <dt>Returns:</dt> 1019 <dt>Return:</dt>
1020 <dd> 1020 <dd>
1021 value indicating an applied/deferred fix (-1, 0, 1), 1021 value indicating an applied/deferred fix (-1, 0, 1),
1022 a message code for the fix, a list of arguments for the 1022 a message code for the fix, a list of arguments for the
1023 message and an ID for a deferred fix 1023 message and an ID for a deferred fix
1024 </dd> 1024 </dd>
1058 <dd> 1058 <dd>
1059 flag indicating, that the fix should be applied 1059 flag indicating, that the fix should be applied
1060 </dd> 1060 </dd>
1061 </dl> 1061 </dl>
1062 <dl> 1062 <dl>
1063 <dt>Returns:</dt> 1063 <dt>Return:</dt>
1064 <dd> 1064 <dd>
1065 value indicating an applied/deferred fix (-1, 0, 1), 1065 value indicating an applied/deferred fix (-1, 0, 1),
1066 a message code for the fix, a list of arguments for the 1066 a message code for the fix, a list of arguments for the
1067 message and an ID for a deferred fix 1067 message and an ID for a deferred fix
1068 </dd> 1068 </dd>
1101 <dd> 1101 <dd>
1102 flag indicating, that the fix should be applied 1102 flag indicating, that the fix should be applied
1103 </dd> 1103 </dd>
1104 </dl> 1104 </dl>
1105 <dl> 1105 <dl>
1106 <dt>Returns:</dt> 1106 <dt>Return:</dt>
1107 <dd> 1107 <dd>
1108 value indicating an applied/deferred fix (-1, 0, 1), 1108 value indicating an applied/deferred fix (-1, 0, 1),
1109 a message code for the fix, a list of arguments for the 1109 a message code for the fix, a list of arguments for the
1110 message and an ID for a deferred fix 1110 message and an ID for a deferred fix
1111 </dd> 1111 </dd>
1144 <dd> 1144 <dd>
1145 flag indicating, that the fix should be applied 1145 flag indicating, that the fix should be applied
1146 </dd> 1146 </dd>
1147 </dl> 1147 </dl>
1148 <dl> 1148 <dl>
1149 <dt>Returns:</dt> 1149 <dt>Return:</dt>
1150 <dd> 1150 <dd>
1151 value indicating an applied/deferred fix (-1, 0, 1), 1151 value indicating an applied/deferred fix (-1, 0, 1),
1152 a message code for the fix, a list of arguments for the 1152 a message code for the fix, a list of arguments for the
1153 message and an ID for a deferred fix 1153 message and an ID for a deferred fix
1154 </dd> 1154 </dd>
1188 <dd> 1188 <dd>
1189 flag indicating, that the fix should be applied 1189 flag indicating, that the fix should be applied
1190 </dd> 1190 </dd>
1191 </dl> 1191 </dl>
1192 <dl> 1192 <dl>
1193 <dt>Returns:</dt> 1193 <dt>Return:</dt>
1194 <dd> 1194 <dd>
1195 value indicating an applied/deferred fix (-1, 0, 1), 1195 value indicating an applied/deferred fix (-1, 0, 1),
1196 a message code for the fix, a list of arguments for the 1196 a message code for the fix, a list of arguments for the
1197 message and an ID for a deferred fix 1197 message and an ID for a deferred fix
1198 </dd> 1198 </dd>
1232 <dd> 1232 <dd>
1233 flag indicating, that the fix should be applied 1233 flag indicating, that the fix should be applied
1234 </dd> 1234 </dd>
1235 </dl> 1235 </dl>
1236 <dl> 1236 <dl>
1237 <dt>Returns:</dt> 1237 <dt>Return:</dt>
1238 <dd> 1238 <dd>
1239 value indicating an applied/deferred fix (-1, 0, 1), 1239 value indicating an applied/deferred fix (-1, 0, 1),
1240 a message code for the fix, a list of arguments for the 1240 a message code for the fix, a list of arguments for the
1241 message and an ID for a deferred fix 1241 message and an ID for a deferred fix
1242 </dd> 1242 </dd>
1275 <dd> 1275 <dd>
1276 flag indicating, that the fix should be applied 1276 flag indicating, that the fix should be applied
1277 </dd> 1277 </dd>
1278 </dl> 1278 </dl>
1279 <dl> 1279 <dl>
1280 <dt>Returns:</dt> 1280 <dt>Return:</dt>
1281 <dd> 1281 <dd>
1282 value indicating an applied/deferred fix (-1, 0, 1), 1282 value indicating an applied/deferred fix (-1, 0, 1),
1283 a message code for the fix, a list of arguments for the 1283 a message code for the fix, a list of arguments for the
1284 message and an ID for a deferred fix 1284 message and an ID for a deferred fix
1285 </dd> 1285 </dd>
1314 <dd> 1314 <dd>
1315 position inside line 1315 position inside line
1316 </dd> 1316 </dd>
1317 </dl> 1317 </dl>
1318 <dl> 1318 <dl>
1319 <dt>Returns:</dt> 1319 <dt>Return:</dt>
1320 <dd> 1320 <dd>
1321 value indicating an applied/deferred fix (-1, 0, 1), 1321 value indicating an applied/deferred fix (-1, 0, 1),
1322 a message code for the fix, a list of arguments for the 1322 a message code for the fix, a list of arguments for the
1323 message and an ID for a deferred fix 1323 message and an ID for a deferred fix
1324 </dd> 1324 </dd>
1354 <dd> 1354 <dd>
1355 position inside line 1355 position inside line
1356 </dd> 1356 </dd>
1357 </dl> 1357 </dl>
1358 <dl> 1358 <dl>
1359 <dt>Returns:</dt> 1359 <dt>Return:</dt>
1360 <dd> 1360 <dd>
1361 value indicating an applied/deferred fix (-1, 0, 1), 1361 value indicating an applied/deferred fix (-1, 0, 1),
1362 a message code for the fix, a list of arguments for the 1362 a message code for the fix, a list of arguments for the
1363 message and an ID for a deferred fix 1363 message and an ID for a deferred fix
1364 </dd> 1364 </dd>
1393 <dd> 1393 <dd>
1394 position inside line 1394 position inside line
1395 </dd> 1395 </dd>
1396 </dl> 1396 </dl>
1397 <dl> 1397 <dl>
1398 <dt>Returns:</dt> 1398 <dt>Return:</dt>
1399 <dd> 1399 <dd>
1400 value indicating an applied/deferred fix (-1, 0, 1), 1400 value indicating an applied/deferred fix (-1, 0, 1),
1401 a message code for the fix, a list of arguments for the 1401 a message code for the fix, a list of arguments for the
1402 message and an ID for a deferred fix 1402 message and an ID for a deferred fix
1403 </dd> 1403 </dd>
1432 <dd> 1432 <dd>
1433 position inside line 1433 position inside line
1434 </dd> 1434 </dd>
1435 </dl> 1435 </dl>
1436 <dl> 1436 <dl>
1437 <dt>Returns:</dt> 1437 <dt>Return:</dt>
1438 <dd> 1438 <dd>
1439 value indicating an applied/deferred fix (-1, 0, 1), 1439 value indicating an applied/deferred fix (-1, 0, 1),
1440 a message code for the fix, a list of arguments for the 1440 a message code for the fix, a list of arguments for the
1441 message and an ID for a deferred fix 1441 message and an ID for a deferred fix
1442 </dd> 1442 </dd>
1472 <dd> 1472 <dd>
1473 position inside line 1473 position inside line
1474 </dd> 1474 </dd>
1475 </dl> 1475 </dl>
1476 <dl> 1476 <dl>
1477 <dt>Returns:</dt> 1477 <dt>Return:</dt>
1478 <dd> 1478 <dd>
1479 value indicating an applied/deferred fix (-1, 0, 1), 1479 value indicating an applied/deferred fix (-1, 0, 1),
1480 a message code for the fix, a list of arguments for the 1480 a message code for the fix, a list of arguments for the
1481 message and an ID for a deferred fix 1481 message and an ID for a deferred fix
1482 </dd> 1482 </dd>
1511 <dd> 1511 <dd>
1512 position inside line 1512 position inside line
1513 </dd> 1513 </dd>
1514 </dl> 1514 </dl>
1515 <dl> 1515 <dl>
1516 <dt>Returns:</dt> 1516 <dt>Return:</dt>
1517 <dd> 1517 <dd>
1518 value indicating an applied/deferred fix (-1, 0, 1), 1518 value indicating an applied/deferred fix (-1, 0, 1),
1519 a message code for the fix, a list of arguments for the 1519 a message code for the fix, a list of arguments for the
1520 message and an ID for a deferred fix 1520 message and an ID for a deferred fix
1521 </dd> 1521 </dd>
1555 <dd> 1555 <dd>
1556 flag indicating, that the fix should be applied 1556 flag indicating, that the fix should be applied
1557 </dd> 1557 </dd>
1558 </dl> 1558 </dl>
1559 <dl> 1559 <dl>
1560 <dt>Returns:</dt> 1560 <dt>Return:</dt>
1561 <dd> 1561 <dd>
1562 value indicating an applied/deferred fix (-1, 0, 1), 1562 value indicating an applied/deferred fix (-1, 0, 1),
1563 a message code for the fix, a list of arguments for the 1563 a message code for the fix, a list of arguments for the
1564 message and an ID for a deferred fix 1564 message and an ID for a deferred fix
1565 </dd> 1565 </dd>
1598 <dd> 1598 <dd>
1599 flag indicating, that the fix should be applied 1599 flag indicating, that the fix should be applied
1600 </dd> 1600 </dd>
1601 </dl> 1601 </dl>
1602 <dl> 1602 <dl>
1603 <dt>Returns:</dt> 1603 <dt>Return:</dt>
1604 <dd> 1604 <dd>
1605 value indicating an applied/deferred fix (-1, 0, 1), 1605 value indicating an applied/deferred fix (-1, 0, 1),
1606 a message code for the fix, a list of arguments for the 1606 a message code for the fix, a list of arguments for the
1607 message and an ID for a deferred fix 1607 message and an ID for a deferred fix
1608 </dd> 1608 </dd>
1641 <dd> 1641 <dd>
1642 flag indicating, that the fix should be applied 1642 flag indicating, that the fix should be applied
1643 </dd> 1643 </dd>
1644 </dl> 1644 </dl>
1645 <dl> 1645 <dl>
1646 <dt>Returns:</dt> 1646 <dt>Return:</dt>
1647 <dd> 1647 <dd>
1648 value indicating an applied/deferred fix (-1, 0, 1), 1648 value indicating an applied/deferred fix (-1, 0, 1),
1649 a message code for the fix, a list of arguments for the 1649 a message code for the fix, a list of arguments for the
1650 message and an ID for a deferred fix 1650 message and an ID for a deferred fix
1651 </dd> 1651 </dd>
1680 <dd> 1680 <dd>
1681 position inside line 1681 position inside line
1682 </dd> 1682 </dd>
1683 </dl> 1683 </dl>
1684 <dl> 1684 <dl>
1685 <dt>Returns:</dt> 1685 <dt>Return:</dt>
1686 <dd> 1686 <dd>
1687 value indicating an applied/deferred fix (-1, 0, 1), 1687 value indicating an applied/deferred fix (-1, 0, 1),
1688 a message code for the fix, a list of arguments for the 1688 a message code for the fix, a list of arguments for the
1689 message and an ID for a deferred fix 1689 message and an ID for a deferred fix
1690 </dd> 1690 </dd>
1723 <dd> 1723 <dd>
1724 flag indicating, that the fix should be applied 1724 flag indicating, that the fix should be applied
1725 </dd> 1725 </dd>
1726 </dl> 1726 </dl>
1727 <dl> 1727 <dl>
1728 <dt>Returns:</dt> 1728 <dt>Return:</dt>
1729 <dd> 1729 <dd>
1730 value indicating an applied/deferred fix (-1, 0, 1), 1730 value indicating an applied/deferred fix (-1, 0, 1),
1731 a message code for the fix, a list of arguments for the 1731 a message code for the fix, a list of arguments for the
1732 message and an ID for a deferred fix 1732 message and an ID for a deferred fix
1733 </dd> 1733 </dd>
1766 <dd> 1766 <dd>
1767 flag indicating, that the fix should be applied 1767 flag indicating, that the fix should be applied
1768 </dd> 1768 </dd>
1769 </dl> 1769 </dl>
1770 <dl> 1770 <dl>
1771 <dt>Returns:</dt> 1771 <dt>Return:</dt>
1772 <dd> 1772 <dd>
1773 value indicating an applied/deferred fix (-1, 0, 1), 1773 value indicating an applied/deferred fix (-1, 0, 1),
1774 a message code for the fix, a list of arguments for the 1774 a message code for the fix, a list of arguments for the
1775 message and an ID for a deferred fix 1775 message and an ID for a deferred fix
1776 </dd> 1776 </dd>
1805 <dd> 1805 <dd>
1806 position inside line 1806 position inside line
1807 </dd> 1807 </dd>
1808 </dl> 1808 </dl>
1809 <dl> 1809 <dl>
1810 <dt>Returns:</dt> 1810 <dt>Return:</dt>
1811 <dd> 1811 <dd>
1812 value indicating an applied/deferred fix (-1, 0, 1), 1812 value indicating an applied/deferred fix (-1, 0, 1),
1813 a message code for the fix, a list of arguments for the 1813 a message code for the fix, a list of arguments for the
1814 message and an ID for a deferred fix 1814 message and an ID for a deferred fix
1815 </dd> 1815 </dd>
1849 <dd> 1849 <dd>
1850 flag indicating, that the fix should be applied 1850 flag indicating, that the fix should be applied
1851 </dd> 1851 </dd>
1852 </dl> 1852 </dl>
1853 <dl> 1853 <dl>
1854 <dt>Returns:</dt> 1854 <dt>Return:</dt>
1855 <dd> 1855 <dd>
1856 value indicating an applied/deferred fix (-1, 0, 1), 1856 value indicating an applied/deferred fix (-1, 0, 1),
1857 a message code for the fix, a list of arguments for the 1857 a message code for the fix, a list of arguments for the
1858 message and an ID for a deferred fix 1858 message and an ID for a deferred fix
1859 </dd> 1859 </dd>
1892 <dd> 1892 <dd>
1893 flag indicating, that the fix should be applied 1893 flag indicating, that the fix should be applied
1894 </dd> 1894 </dd>
1895 </dl> 1895 </dl>
1896 <dl> 1896 <dl>
1897 <dt>Returns:</dt> 1897 <dt>Return:</dt>
1898 <dd> 1898 <dd>
1899 value indicating an applied/deferred fix (-1, 0, 1), 1899 value indicating an applied/deferred fix (-1, 0, 1),
1900 a message code for the fix, a list of arguments for the 1900 a message code for the fix, a list of arguments for the
1901 message and an ID for a deferred fix 1901 message and an ID for a deferred fix
1902 </dd> 1902 </dd>
1931 <dd> 1931 <dd>
1932 logical line structure 1932 logical line structure
1933 </dd> 1933 </dd>
1934 </dl> 1934 </dl>
1935 <dl> 1935 <dl>
1936 <dt>Returns:</dt> 1936 <dt>Return:</dt>
1937 <dd> 1937 <dd>
1938 flag indicating a change was done (boolean) 1938 flag indicating a change was done (boolean)
1939 </dd> 1939 </dd>
1940 </dl> 1940 </dl>
1941 <dl> 1941 <dl>
1969 <dd> 1969 <dd>
1970 position inside line 1970 position inside line
1971 </dd> 1971 </dd>
1972 </dl> 1972 </dl>
1973 <dl> 1973 <dl>
1974 <dt>Returns:</dt> 1974 <dt>Return:</dt>
1975 <dd> 1975 <dd>
1976 value indicating an applied/deferred fix (-1, 0, 1), 1976 value indicating an applied/deferred fix (-1, 0, 1),
1977 a message code for the fix, a list of arguments for the 1977 a message code for the fix, a list of arguments for the
1978 message and an ID for a deferred fix 1978 message and an ID for a deferred fix
1979 </dd> 1979 </dd>
2008 <dd> 2008 <dd>
2009 position inside line 2009 position inside line
2010 </dd> 2010 </dd>
2011 </dl> 2011 </dl>
2012 <dl> 2012 <dl>
2013 <dt>Returns:</dt> 2013 <dt>Return:</dt>
2014 <dd> 2014 <dd>
2015 value indicating an applied/deferred fix (-1, 0, 1), 2015 value indicating an applied/deferred fix (-1, 0, 1),
2016 a message code for the fix, a list of arguments for the 2016 a message code for the fix, a list of arguments for the
2017 message and an ID for a deferred fix 2017 message and an ID for a deferred fix
2018 </dd> 2018 </dd>
2047 <dd> 2047 <dd>
2048 position inside line 2048 position inside line
2049 </dd> 2049 </dd>
2050 </dl> 2050 </dl>
2051 <dl> 2051 <dl>
2052 <dt>Returns:</dt> 2052 <dt>Return:</dt>
2053 <dd> 2053 <dd>
2054 value indicating an applied/deferred fix (-1, 0, 1), 2054 value indicating an applied/deferred fix (-1, 0, 1),
2055 a message code for the fix, a list of arguments for the 2055 a message code for the fix, a list of arguments for the
2056 message and an ID for a deferred fix 2056 message and an ID for a deferred fix
2057 </dd> 2057 </dd>
2086 <dd> 2086 <dd>
2087 position inside line 2087 position inside line
2088 </dd> 2088 </dd>
2089 </dl> 2089 </dl>
2090 <dl> 2090 <dl>
2091 <dt>Returns:</dt> 2091 <dt>Return:</dt>
2092 <dd> 2092 <dd>
2093 value indicating an applied/deferred fix (-1, 0, 1), 2093 value indicating an applied/deferred fix (-1, 0, 1),
2094 a message code for the fix, a list of arguments for the 2094 a message code for the fix, a list of arguments for the
2095 message and an ID for a deferred fix 2095 message and an ID for a deferred fix
2096 </dd> 2096 </dd>
2122 <dd> 2122 <dd>
2123 replacement string (string) 2123 replacement string (string)
2124 </dd> 2124 </dd>
2125 </dl> 2125 </dl>
2126 <dl> 2126 <dl>
2127 <dt>Returns:</dt> 2127 <dt>Return:</dt>
2128 <dd> 2128 <dd>
2129 corrected line 2129 corrected line
2130 </dd> 2130 </dd>
2131 </dl> 2131 </dl>
2132 <a NAME="CodeStyleFixer.__getID" ID="CodeStyleFixer.__getID"></a> 2132 <a NAME="CodeStyleFixer.__getID" ID="CodeStyleFixer.__getID"></a>
2135 2135
2136 <p> 2136 <p>
2137 Private method to get the ID for a deferred fix. 2137 Private method to get the ID for a deferred fix.
2138 </p> 2138 </p>
2139 <dl> 2139 <dl>
2140 <dt>Returns:</dt> 2140 <dt>Return:</dt>
2141 <dd> 2141 <dd>
2142 ID for a deferred fix (integer) 2142 ID for a deferred fix (integer)
2143 </dd> 2143 </dd>
2144 </dl> 2144 </dl>
2145 <a NAME="CodeStyleFixer.__getIndent" ID="CodeStyleFixer.__getIndent"></a> 2145 <a NAME="CodeStyleFixer.__getIndent" ID="CodeStyleFixer.__getIndent"></a>
2155 <dd> 2155 <dd>
2156 line to determine the indentation string from (string) 2156 line to determine the indentation string from (string)
2157 </dd> 2157 </dd>
2158 </dl> 2158 </dl>
2159 <dl> 2159 <dl>
2160 <dt>Returns:</dt> 2160 <dt>Return:</dt>
2161 <dd> 2161 <dd>
2162 indentation string (string) 2162 indentation string (string)
2163 </dd> 2163 </dd>
2164 </dl> 2164 </dl>
2165 <a NAME="CodeStyleFixer.__getIndentWord" ID="CodeStyleFixer.__getIndentWord"></a> 2165 <a NAME="CodeStyleFixer.__getIndentWord" ID="CodeStyleFixer.__getIndentWord"></a>
2168 2168
2169 <p> 2169 <p>
2170 Private method to determine the indentation type. 2170 Private method to determine the indentation type.
2171 </p> 2171 </p>
2172 <dl> 2172 <dl>
2173 <dt>Returns:</dt> 2173 <dt>Return:</dt>
2174 <dd> 2174 <dd>
2175 string to be used for an indentation (string) 2175 string to be used for an indentation (string)
2176 </dd> 2176 </dd>
2177 </dl> 2177 </dl>
2178 <a NAME="CodeStyleFixer.__getLogical" ID="CodeStyleFixer.__getLogical"></a> 2178 <a NAME="CodeStyleFixer.__getLogical" ID="CodeStyleFixer.__getLogical"></a>
2193 <dd> 2193 <dd>
2194 position inside line (integer) 2194 position inside line (integer)
2195 </dd> 2195 </dd>
2196 </dl> 2196 </dl>
2197 <dl> 2197 <dl>
2198 <dt>Returns:</dt> 2198 <dt>Return:</dt>
2199 <dd> 2199 <dd>
2200 tuple of a tuple of two integers giving the start of the 2200 tuple of a tuple of two integers giving the start of the
2201 logical line, another tuple of two integers giving the end 2201 logical line, another tuple of two integers giving the end
2202 of the logical line and a list of strings with the original 2202 of the logical line and a list of strings with the original
2203 source lines 2203 source lines
2210 <p> 2210 <p>
2211 Private method to determine the line numbers that are within multi line 2211 Private method to determine the line numbers that are within multi line
2212 strings and these which are part of a documentation string. 2212 strings and these which are part of a documentation string.
2213 </p> 2213 </p>
2214 <dl> 2214 <dl>
2215 <dt>Returns:</dt> 2215 <dt>Return:</dt>
2216 <dd> 2216 <dd>
2217 tuple of a set of line numbers belonging to a multi line 2217 tuple of a set of line numbers belonging to a multi line
2218 string and a set of line numbers belonging to a multi line 2218 string and a set of line numbers belonging to a multi line
2219 documentation string (tuple of two set of integer) 2219 documentation string (tuple of two set of integer)
2220 </dd> 2220 </dd>
2225 2225
2226 <p> 2226 <p>
2227 Public method to apply all deferred fixes. 2227 Public method to apply all deferred fixes.
2228 </p> 2228 </p>
2229 <dl> 2229 <dl>
2230 <dt>Returns:</dt> 2230 <dt>Return:</dt>
2231 <dd> 2231 <dd>
2232 dictionary containing the fix results 2232 dictionary containing the fix results
2233 </dd> 2233 </dd>
2234 </dl> 2234 </dl>
2235 <a NAME="CodeStyleFixer.fixIssue" ID="CodeStyleFixer.fixIssue"></a> 2235 <a NAME="CodeStyleFixer.fixIssue" ID="CodeStyleFixer.fixIssue"></a>
2253 <dd> 2253 <dd>
2254 code of the issue 2254 code of the issue
2255 </dd> 2255 </dd>
2256 </dl> 2256 </dl>
2257 <dl> 2257 <dl>
2258 <dt>Returns:</dt> 2258 <dt>Return:</dt>
2259 <dd> 2259 <dd>
2260 value indicating an applied/deferred fix (-1, 0, 1), 2260 value indicating an applied/deferred fix (-1, 0, 1),
2261 a message code for the fix, arguments list for the message 2261 a message code for the fix, arguments list for the message
2262 and an ID for a deferred fix 2262 and an ID for a deferred fix
2263 </dd> 2263 </dd>
2275 <p> 2275 <p>
2276 Local helper method to compare the beginnings of two strings 2276 Local helper method to compare the beginnings of two strings
2277 against each other. 2277 against each other.
2278 </p> 2278 </p>
2279 <dl> 2279 <dl>
2280 <dt>Returns:</dt> 2280 <dt>Return:</dt>
2281 <dd> 2281 <dd>
2282 flag indicating that one string starts with the other 2282 flag indicating that one string starts with the other
2283 (boolean) 2283 (boolean)
2284 </dd> 2284 </dd>
2285 </dl> 2285 </dl>
2296 <dd> 2296 <dd>
2297 encoding of the source file (string) 2297 encoding of the source file (string)
2298 </dd> 2298 </dd>
2299 </dl> 2299 </dl>
2300 <dl> 2300 <dl>
2301 <dt>Returns:</dt> 2301 <dt>Return:</dt>
2302 <dd> 2302 <dd>
2303 error message on failure (tuple of str) 2303 error message on failure (tuple of str)
2304 </dd> 2304 </dd>
2305 </dl> 2305 </dl>
2306 <div align="right"><a href="#top">Up</a></div> 2306 <div align="right"><a href="#top">Up</a></div>
2378 <dd> 2378 <dd>
2379 list of tokens as generated by tokenize.generate_tokens 2379 list of tokens as generated by tokenize.generate_tokens
2380 </dd> 2380 </dd>
2381 </dl> 2381 </dl>
2382 <dl> 2382 <dl>
2383 <dt>Returns:</dt> 2383 <dt>Return:</dt>
2384 <dd> 2384 <dd>
2385 logical line (string) 2385 logical line (string)
2386 </dd> 2386 </dd>
2387 </dl> 2387 </dl>
2388 <a NAME="IndentationWrapper.pep8Expected" ID="IndentationWrapper.pep8Expected"></a> 2388 <a NAME="IndentationWrapper.pep8Expected" ID="IndentationWrapper.pep8Expected"></a>
2392 <p> 2392 <p>
2393 Public method to replicate logic in pycodestyle.py, to know what level 2393 Public method to replicate logic in pycodestyle.py, to know what level
2394 to indent things to. 2394 to indent things to.
2395 </p> 2395 </p>
2396 <dl> 2396 <dl>
2397 <dt>Returns:</dt> 2397 <dt>Return:</dt>
2398 <dd> 2398 <dd>
2399 list of lists, where each list represents valid indent levels 2399 list of lists, where each list represents valid indent levels
2400 for the line in question, relative from the initial indent. However, 2400 for the line in question, relative from the initial indent. However,
2401 the first entry is the indent level which was expected. 2401 the first entry is the indent level which was expected.
2402 </dd> 2402 </dd>
2522 2522
2523 <p> 2523 <p>
2524 Private method to break multi line strings. 2524 Private method to break multi line strings.
2525 </p> 2525 </p>
2526 <dl> 2526 <dl>
2527 <dt>Returns:</dt> 2527 <dt>Return:</dt>
2528 <dd> 2528 <dd>
2529 tuple of the shortened line and the changed next line 2529 tuple of the shortened line and the changed next line
2530 (string, string) 2530 (string, string)
2531 </dd> 2531 </dd>
2532 </dl> 2532 </dl>
2543 <dd> 2543 <dd>
2544 code fragment to check (string) 2544 code fragment to check (string)
2545 </dd> 2545 </dd>
2546 </dl> 2546 </dl>
2547 <dl> 2547 <dl>
2548 <dt>Returns:</dt> 2548 <dt>Return:</dt>
2549 <dd> 2549 <dd>
2550 flag indicating syntax is ok (boolean) 2550 flag indicating syntax is ok (boolean)
2551 </dd> 2551 </dd>
2552 </dl> 2552 </dl>
2553 <a NAME="LineShortener.__countUnbalancedBrackets" ID="LineShortener.__countUnbalancedBrackets"></a> 2553 <a NAME="LineShortener.__countUnbalancedBrackets" ID="LineShortener.__countUnbalancedBrackets"></a>
2564 <dd> 2564 <dd>
2565 line to work at (string) 2565 line to work at (string)
2566 </dd> 2566 </dd>
2567 </dl> 2567 </dl>
2568 <dl> 2568 <dl>
2569 <dt>Returns:</dt> 2569 <dt>Return:</dt>
2570 <dd> 2570 <dd>
2571 number of unmatched open/close brackets (integer) 2571 number of unmatched open/close brackets (integer)
2572 </dd> 2572 </dd>
2573 </dl> 2573 </dl>
2574 <a NAME="LineShortener.__getIndent" ID="LineShortener.__getIndent"></a> 2574 <a NAME="LineShortener.__getIndent" ID="LineShortener.__getIndent"></a>
2584 <dd> 2584 <dd>
2585 line to determine the indentation string from (string) 2585 line to determine the indentation string from (string)
2586 </dd> 2586 </dd>
2587 </dl> 2587 </dl>
2588 <dl> 2588 <dl>
2589 <dt>Returns:</dt> 2589 <dt>Return:</dt>
2590 <dd> 2590 <dd>
2591 indentation string (string) 2591 indentation string (string)
2592 </dd> 2592 </dd>
2593 </dl> 2593 </dl>
2594 <a NAME="LineShortener.__isProbablyInsideStringOrComment" ID="LineShortener.__isProbablyInsideStringOrComment"></a> 2594 <a NAME="LineShortener.__isProbablyInsideStringOrComment" ID="LineShortener.__isProbablyInsideStringOrComment"></a>
2609 <dd> 2609 <dd>
2610 position inside line to check (integer) 2610 position inside line to check (integer)
2611 </dd> 2611 </dd>
2612 </dl> 2612 </dl>
2613 <dl> 2613 <dl>
2614 <dt>Returns:</dt> 2614 <dt>Return:</dt>
2615 <dd> 2615 <dd>
2616 flag indicating the possibility of being inside a string 2616 flag indicating the possibility of being inside a string
2617 or comment 2617 or comment
2618 </dd> 2618 </dd>
2619 </dl> 2619 </dl>
2630 <dd> 2630 <dd>
2631 candidate line to rank (string) 2631 candidate line to rank (string)
2632 </dd> 2632 </dd>
2633 </dl> 2633 </dl>
2634 <dl> 2634 <dl>
2635 <dt>Returns:</dt> 2635 <dt>Return:</dt>
2636 <dd> 2636 <dd>
2637 rank of the candidate (integer) 2637 rank of the candidate (integer)
2638 </dd> 2638 </dd>
2639 </dl> 2639 </dl>
2640 <a NAME="LineShortener.__normalizeMultiline" ID="LineShortener.__normalizeMultiline"></a> 2640 <a NAME="LineShortener.__normalizeMultiline" ID="LineShortener.__normalizeMultiline"></a>
2651 <dd> 2651 <dd>
2652 code line to work on (string) 2652 code line to work on (string)
2653 </dd> 2653 </dd>
2654 </dl> 2654 </dl>
2655 <dl> 2655 <dl>
2656 <dt>Returns:</dt> 2656 <dt>Return:</dt>
2657 <dd> 2657 <dd>
2658 normalized code line (string) 2658 normalized code line (string)
2659 </dd> 2659 </dd>
2660 </dl> 2660 </dl>
2661 <a NAME="LineShortener.__shortenComment" ID="LineShortener.__shortenComment"></a> 2661 <a NAME="LineShortener.__shortenComment" ID="LineShortener.__shortenComment"></a>
2672 flag indicating, that the line is the last comment line 2672 flag indicating, that the line is the last comment line
2673 (boolean) 2673 (boolean)
2674 </dd> 2674 </dd>
2675 </dl> 2675 </dl>
2676 <dl> 2676 <dl>
2677 <dt>Returns:</dt> 2677 <dt>Return:</dt>
2678 <dd> 2678 <dd>
2679 shortened comment line (string) 2679 shortened comment line (string)
2680 </dd> 2680 </dd>
2681 </dl> 2681 </dl>
2682 <a NAME="LineShortener.__shortenLine" ID="LineShortener.__shortenLine"></a> 2682 <a NAME="LineShortener.__shortenLine" ID="LineShortener.__shortenLine"></a>
2701 <dd> 2701 <dd>
2702 indentation string of the code line (string) 2702 indentation string of the code line (string)
2703 </dd> 2703 </dd>
2704 </dl> 2704 </dl>
2705 <dl> 2705 <dl>
2706 <dt>Returns:</dt> 2706 <dt>Return:</dt>
2707 <dd> 2707 <dd>
2708 list of candidates (list of string) 2708 list of candidates (list of string)
2709 </dd> 2709 </dd>
2710 </dl> 2710 </dl>
2711 <a NAME="LineShortener.shorten" ID="LineShortener.shorten"></a> 2711 <a NAME="LineShortener.shorten" ID="LineShortener.shorten"></a>
2714 2714
2715 <p> 2715 <p>
2716 Public method to shorten the line wrapped by the class instance. 2716 Public method to shorten the line wrapped by the class instance.
2717 </p> 2717 </p>
2718 <dl> 2718 <dl>
2719 <dt>Returns:</dt> 2719 <dt>Return:</dt>
2720 <dd> 2720 <dd>
2721 tuple of a flag indicating successful shortening, the 2721 tuple of a flag indicating successful shortening, the
2722 shortened line and the changed next line (boolean, string, string) 2722 shortened line and the changed next line (boolean, string, string)
2723 </dd> 2723 </dd>
2724 </dl> 2724 </dl>
2810 <dd> 2810 <dd>
2811 tokens generator (tokenize._tokenize) 2811 tokens generator (tokenize._tokenize)
2812 </dd> 2812 </dd>
2813 </dl> 2813 </dl>
2814 <dl> 2814 <dl>
2815 <dt>Returns:</dt> 2815 <dt>Return:</dt>
2816 <dd> 2816 <dd>
2817 reference to the generated statistics 2817 reference to the generated statistics
2818 </dd> 2818 </dd>
2819 </dl> 2819 </dl>
2820 <a NAME="Reindenter.__getlspace" ID="Reindenter.__getlspace"></a> 2820 <a NAME="Reindenter.__getlspace" ID="Reindenter.__getlspace"></a>
2830 <dd> 2830 <dd>
2831 line to check (string) 2831 line to check (string)
2832 </dd> 2832 </dd>
2833 </dl> 2833 </dl>
2834 <dl> 2834 <dl>
2835 <dt>Returns:</dt> 2835 <dt>Return:</dt>
2836 <dd> 2836 <dd>
2837 number of leading blanks (integer) 2837 number of leading blanks (integer)
2838 </dd> 2838 </dd>
2839 </dl> 2839 </dl>
2840 <a NAME="Reindenter.fixedLine" ID="Reindenter.fixedLine"></a> 2840 <a NAME="Reindenter.fixedLine" ID="Reindenter.fixedLine"></a>
2850 <dd> 2850 <dd>
2851 number of the line to retrieve (integer) 2851 number of the line to retrieve (integer)
2852 </dd> 2852 </dd>
2853 </dl> 2853 </dl>
2854 <dl> 2854 <dl>
2855 <dt>Returns:</dt> 2855 <dt>Return:</dt>
2856 <dd> 2856 <dd>
2857 fixed line (string) 2857 fixed line (string)
2858 </dd> 2858 </dd>
2859 </dl> 2859 </dl>
2860 <a NAME="Reindenter.getline" ID="Reindenter.getline"></a> 2860 <a NAME="Reindenter.getline" ID="Reindenter.getline"></a>
2863 2863
2864 <p> 2864 <p>
2865 Public method to get a line of text for tokenize. 2865 Public method to get a line of text for tokenize.
2866 </p> 2866 </p>
2867 <dl> 2867 <dl>
2868 <dt>Returns:</dt> 2868 <dt>Return:</dt>
2869 <dd> 2869 <dd>
2870 line of text (string) 2870 line of text (string)
2871 </dd> 2871 </dd>
2872 </dl> 2872 </dl>
2873 <a NAME="Reindenter.run" ID="Reindenter.run"></a> 2873 <a NAME="Reindenter.run" ID="Reindenter.run"></a>
2876 2876
2877 <p> 2877 <p>
2878 Public method to run the re-indenter. 2878 Public method to run the re-indenter.
2879 </p> 2879 </p>
2880 <dl> 2880 <dl>
2881 <dt>Returns:</dt> 2881 <dt>Return:</dt>
2882 <dd> 2882 <dd>
2883 flag indicating that a change was done (boolean) 2883 flag indicating that a change was done (boolean)
2884 </dd> 2884 </dd>
2885 </dl> 2885 </dl>
2886 <div align="right"><a href="#top">Up</a></div> 2886 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial