Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html

branch
eric7
changeset 10437
2f70ca07f0af
parent 10259
b51dfacef37f
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html	Fri Dec 22 17:24:07 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html	Fri Dec 22 19:45:17 2023 +0100
@@ -349,15 +349,21 @@
 </p>
 <dl>
 
-<dt><i>code</i></dt>
-<dd>
-to check (string)
+<dt><i>code</i> (str)</dt>
+<dd>
+to check
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating it should be fixed (boolean)
+flag indicating it should be fixed
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="CodeStyleFixer.__findLogical" ID="CodeStyleFixer.__findLogical"></a>
@@ -375,6 +381,12 @@
             of lines
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of ([int, int], [int, int])
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixBlankLinesBefore" ID="CodeStyleFixer.__fixBlankLinesBefore"></a>
 <h4>CodeStyleFixer.__fixBlankLinesBefore</h4>
 <b>__fixBlankLinesBefore</b>(<i>code, line, pos, apply=False</i>)
@@ -1905,15 +1917,15 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-line number of the issue (integer)
-</dd>
-<dt><i>pos</i></dt>
-<dd>
-position inside line (integer)
-</dd>
-<dt><i>logical</i></dt>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+<dt><i>logical</i> (str)</dt>
 <dd>
 logical line structure
 </dd>
@@ -1921,7 +1933,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a change was done (boolean)
+flag indicating a change was done
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>
@@ -2096,17 +2114,17 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-line to be corrected (string)
-</dd>
-<dt><i>offset</i></dt>
-<dd>
-offset within line (integer)
-</dd>
-<dt><i>replacement</i></dt>
-<dd>
-replacement string (string)
+<dt><i>line</i> (str)</dt>
+<dd>
+line to be corrected
+</dd>
+<dt><i>offset</i> (int)</dt>
+<dd>
+offset within line
+</dd>
+<dt><i>replacement</i> (str)</dt>
+<dd>
+replacement string
 </dd>
 </dl>
 <dl>
@@ -2115,6 +2133,12 @@
 corrected line
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__getID" ID="CodeStyleFixer.__getID"></a>
 <h4>CodeStyleFixer.__getID</h4>
 <b>__getID</b>(<i></i>)
@@ -2125,7 +2149,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-ID for a deferred fix (integer)
+ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="CodeStyleFixer.__getIndent" ID="CodeStyleFixer.__getIndent"></a>
@@ -2137,15 +2167,21 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-line to determine the indentation string from (string)
+<dt><i>line</i> (str)</dt>
+<dd>
+line to determine the indentation string from
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-indentation string (string)
+indentation string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="CodeStyleFixer.__getIndentWord" ID="CodeStyleFixer.__getIndentWord"></a>
@@ -2158,7 +2194,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-string to be used for an indentation (string)
+string to be used for an indentation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="CodeStyleFixer.__getLogical" ID="CodeStyleFixer.__getLogical"></a>
@@ -2171,13 +2213,13 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-line number of the issue (integer)
-</dd>
-<dt><i>pos</i></dt>
-<dd>
-position inside line (integer)
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
 </dd>
 </dl>
 <dl>
@@ -2189,6 +2231,12 @@
             source lines
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of ((int, int), (int, int), [str])
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__multilineStringLines" ID="CodeStyleFixer.__multilineStringLines"></a>
 <h4>CodeStyleFixer.__multilineStringLines</h4>
 <b>__multilineStringLines</b>(<i></i>)
@@ -2202,7 +2250,13 @@
 <dd>
 tuple of a set of line numbers belonging to a multi line
             string and a set of line numbers belonging to a multi line
-            documentation string (tuple of two set of integer)
+            documentation string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (set of int, set of int)
 </dd>
 </dl>
 <a NAME="CodeStyleFixer.finalize" ID="CodeStyleFixer.finalize"></a>
@@ -2218,6 +2272,12 @@
 dictionary containing the fix results
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.fixIssue" ID="CodeStyleFixer.fixIssue"></a>
 <h4>CodeStyleFixer.fixIssue</h4>
 <b>fixIssue</b>(<i>line, pos, code</i>)
@@ -2266,7 +2326,12 @@
 <dt>Return:</dt>
 <dd>
 flag indicating that one string starts with the other
-                (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="CodeStyleFixer.saveFile" ID="CodeStyleFixer.saveFile"></a>
@@ -2278,15 +2343,21 @@
 </p>
 <dl>
 
-<dt><i>encoding</i></dt>
-<dd>
-encoding of the source file (string)
+<dt><i>encoding</i> (str)</dt>
+<dd>
+encoding of the source file
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-error message on failure (tuple of str)
+error message on failure
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, [str])
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -2345,10 +2416,9 @@
 </p>
 <dl>
 
-<dt><i>physical_lines</i></dt>
+<dt><i>physical_lines</i> (list of str)</dt>
 <dd>
 list of physical lines to operate on
-            (list of strings)
 </dd>
 </dl>
 <a NAME="IndentationWrapper.__buildTokensLogical" ID="IndentationWrapper.__buildTokensLogical"></a>
@@ -2360,7 +2430,7 @@
 </p>
 <dl>
 
-<dt><i>tokens</i></dt>
+<dt><i>tokens</i> (list of Token)</dt>
 <dd>
 list of tokens as generated by tokenize.generate_tokens
 </dd>
@@ -2368,7 +2438,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-logical line (string)
+logical line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="IndentationWrapper.pep8Expected" ID="IndentationWrapper.pep8Expected"></a>
@@ -2383,8 +2459,14 @@
 <dt>Return:</dt>
 <dd>
 list of lists, where each list represents valid indent levels
-        for the line in question, relative from the initial indent. However,
-        the first entry is the indent level which was expected.
+            for the line in question, relative from the initial indent. However,
+            the first entry is the indent level which was expected.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of list
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -2472,34 +2554,34 @@
 </p>
 <dl>
 
-<dt><i>curLine</i></dt>
-<dd>
-text to work on (string)
-</dd>
-<dt><i>prevLine</i></dt>
-<dd>
-line before the text to work on (string)
-</dd>
-<dt><i>nextLine</i></dt>
-<dd>
-line after the text to work on (string)
-</dd>
-<dt><i>maxLength</i></dt>
-<dd>
-maximum allowed line length (integer)
-</dd>
-<dt><i>eol</i></dt>
-<dd>
-eond-of-line marker (string)
-</dd>
-<dt><i>indentWord</i></dt>
-<dd>
-string used for indentation (string)
-</dd>
-<dt><i>isDocString</i></dt>
+<dt><i>curLine</i> (str)</dt>
+<dd>
+text to work on
+</dd>
+<dt><i>prevLine</i> (str)</dt>
+<dd>
+line before the text to work on
+</dd>
+<dt><i>nextLine</i> (str)</dt>
+<dd>
+line after the text to work on
+</dd>
+<dt><i>maxLength</i> (int)</dt>
+<dd>
+maximum allowed line length
+</dd>
+<dt><i>eol</i> (str)</dt>
+<dd>
+eond-of-line marker
+</dd>
+<dt><i>indentWord</i> (str)</dt>
+<dd>
+string used for indentation
+</dd>
+<dt><i>isDocString</i> (bool)</dt>
 <dd>
 flag indicating that the line belongs to
-            a documentation string (boolean)
+            a documentation string
 </dd>
 </dl>
 <a NAME="LineShortener.__breakMultiline" ID="LineShortener.__breakMultiline"></a>
@@ -2513,7 +2595,12 @@
 <dt>Return:</dt>
 <dd>
 tuple of the shortened line and the changed next line
-            (string, string)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
 </dd>
 </dl>
 <a NAME="LineShortener.__checkSyntax" ID="LineShortener.__checkSyntax"></a>
@@ -2525,15 +2612,21 @@
 </p>
 <dl>
 
-<dt><i>code</i></dt>
-<dd>
-code fragment to check (string)
+<dt><i>code</i> (str)</dt>
+<dd>
+code fragment to check
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating syntax is ok (boolean)
+flag indicating syntax is ok
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="LineShortener.__countUnbalancedBrackets" ID="LineShortener.__countUnbalancedBrackets"></a>
@@ -2546,15 +2639,21 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-line to work at (string)
+<dt><i>line</i> (str)</dt>
+<dd>
+line to work at
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-number of unmatched open/close brackets (integer)
+number of unmatched open/close brackets
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="LineShortener.__getIndent" ID="LineShortener.__getIndent"></a>
@@ -2566,15 +2665,21 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-line to determine the indentation string from (string)
+<dt><i>line</i> (str)</dt>
+<dd>
+line to determine the indentation string from
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-indentation string (string)
+indentation string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="LineShortener.__isProbablyInsideStringOrComment" ID="LineShortener.__isProbablyInsideStringOrComment"></a>
@@ -2587,13 +2692,13 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-line to check (string)
-</dd>
-<dt><i>index</i></dt>
-<dd>
-position inside line to check (integer)
+<dt><i>line</i> (str)</dt>
+<dd>
+line to check
+</dd>
+<dt><i>index</i> (int)</dt>
+<dd>
+position inside line to check
 </dd>
 </dl>
 <dl>
@@ -2603,6 +2708,12 @@
             or comment
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="LineShortener.__lineShorteningRank" ID="LineShortener.__lineShorteningRank"></a>
 <h4>LineShortener.__lineShorteningRank</h4>
 <b>__lineShorteningRank</b>(<i>candidate</i>)
@@ -2612,15 +2723,21 @@
 </p>
 <dl>
 
-<dt><i>candidate</i></dt>
-<dd>
-candidate line to rank (string)
+<dt><i>candidate</i> (str)</dt>
+<dd>
+candidate line to rank
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-rank of the candidate (integer)
+rank of the candidate
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="LineShortener.__normalizeMultiline" ID="LineShortener.__normalizeMultiline"></a>
@@ -2633,15 +2750,21 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
-<dd>
-code line to work on (string)
+<dt><i>text</i> (str)</dt>
+<dd>
+code line to work on
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-normalized code line (string)
+normalized code line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="LineShortener.__shortenComment" ID="LineShortener.__shortenComment"></a>
@@ -2653,16 +2776,21 @@
 </p>
 <dl>
 
-<dt><i>isLast</i></dt>
+<dt><i>isLast</i> (bool)</dt>
 <dd>
 flag indicating, that the line is the last comment line
-            (boolean)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-shortened comment line (string)
+shortened comment line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="LineShortener.__shortenLine" ID="LineShortener.__shortenLine"></a>
@@ -2674,24 +2802,29 @@
 </p>
 <dl>
 
-<dt><i>tokens</i></dt>
+<dt><i>tokens</i> (list of Token)</dt>
 <dd>
 tokens of the line as generated by tokenize
-            (list of token)
-</dd>
-<dt><i>source</i></dt>
-<dd>
-code string to work at (string)
-</dd>
-<dt><i>indent</i></dt>
-<dd>
-indentation string of the code line (string)
+</dd>
+<dt><i>source</i> (str)</dt>
+<dd>
+code string to work at
+</dd>
+<dt><i>indent</i> (str)</dt>
+<dd>
+indentation string of the code line
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of candidates (list of string)
+list of candidates
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="LineShortener.shorten" ID="LineShortener.shorten"></a>
@@ -2705,7 +2838,13 @@
 <dt>Return:</dt>
 <dd>
 tuple of a flag indicating successful shortening, the
-            shortened line and the changed next line (boolean, string, string)
+            shortened line and the changed next line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str, str)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -2777,10 +2916,9 @@
 </p>
 <dl>
 
-<dt><i>sourceLines</i></dt>
+<dt><i>sourceLines</i> (list of str)</dt>
 <dd>
 list of source lines including eol marker
-            (list of string)
 </dd>
 </dl>
 <a NAME="Reindenter.__genStats" ID="Reindenter.__genStats"></a>
@@ -2792,7 +2930,7 @@
 </p>
 <dl>
 
-<dt><i>tokens</i></dt>
+<dt><i>tokens</i> (function)</dt>
 <dd>
 tokens generator (tokenize._tokenize)
 </dd>
@@ -2803,6 +2941,12 @@
 reference to the generated statistics
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <a NAME="Reindenter.__getlspace" ID="Reindenter.__getlspace"></a>
 <h4>Reindenter.__getlspace</h4>
 <b>__getlspace</b>(<i>line</i>)
@@ -2812,15 +2956,21 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-line to check (string)
+<dt><i>line</i> (str)</dt>
+<dd>
+line to check
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-number of leading blanks (integer)
+number of leading blanks
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="Reindenter.fixedLine" ID="Reindenter.fixedLine"></a>
@@ -2832,15 +2982,21 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
-<dd>
-number of the line to retrieve (integer)
+<dt><i>line</i> (int)</dt>
+<dd>
+number of the line to retrieve
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-fixed line (string)
+fixed line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Reindenter.getline" ID="Reindenter.getline"></a>
@@ -2853,7 +3009,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-line of text (string)
+line of text
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Reindenter.run" ID="Reindenter.run"></a>
@@ -2866,7 +3028,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating that a change was done (boolean)
+flag indicating that a change was done
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial