Fri, 27 Sep 2013 18:36:53 +0200
Updated source docu.
--- a/Documentation/Help/source.qhp Fri Sep 27 18:36:07 2013 +0200 +++ b/Documentation/Help/source.qhp Fri Sep 27 18:36:53 2013 +0200 @@ -7987,10 +7987,10 @@ <keyword name="Pep257Checker.__checkEricFunctionArguments" id="Pep257Checker.__checkEricFunctionArguments" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkEricFunctionArguments" /> <keyword name="Pep257Checker.__checkEricNBlankAfterLastParagraph" id="Pep257Checker.__checkEricNBlankAfterLastParagraph" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricNBlankAfterLastParagraph" /> <keyword name="Pep257Checker.__checkEricNBlankAfterLastParagraph" id="Pep257Checker.__checkEricNBlankAfterLastParagraph" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkEricNBlankAfterLastParagraph" /> - <keyword name="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass" id="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricNoBlankBeforeAndAfterClass" /> - <keyword name="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass" id="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkEricNoBlankBeforeAndAfterClass" /> - <keyword name="Pep257Checker.__checkEricOneLiner" id="Pep257Checker.__checkEricOneLiner" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricOneLiner" /> + <keyword name="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" id="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" /> + <keyword name="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" id="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" /> <keyword name="Pep257Checker.__checkEricOneLiner" id="Pep257Checker.__checkEricOneLiner" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkEricOneLiner" /> + <keyword name="Pep257Checker.__checkEricQuotesOnSeparateLines" id="Pep257Checker.__checkEricQuotesOnSeparateLines" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricQuotesOnSeparateLines" /> <keyword name="Pep257Checker.__checkEricReturn" id="Pep257Checker.__checkEricReturn" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricReturn" /> <keyword name="Pep257Checker.__checkEricReturn" id="Pep257Checker.__checkEricReturn" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkEricReturn" /> <keyword name="Pep257Checker.__checkFunctionDocstring" id="Pep257Checker.__checkFunctionDocstring" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkFunctionDocstring" /> @@ -8129,6 +8129,10 @@ <keyword name="Pep8Fixer.__fixD143" id="Pep8Fixer.__fixD143" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD143" /> <keyword name="Pep8Fixer.__fixD144" id="Pep8Fixer.__fixD144" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD144" /> <keyword name="Pep8Fixer.__fixD145" id="Pep8Fixer.__fixD145" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD145" /> + <keyword name="Pep8Fixer.__fixD221" id="Pep8Fixer.__fixD221" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD221" /> + <keyword name="Pep8Fixer.__fixD242" id="Pep8Fixer.__fixD242" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD242" /> + <keyword name="Pep8Fixer.__fixD243" id="Pep8Fixer.__fixD243" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD243" /> + <keyword name="Pep8Fixer.__fixD247" id="Pep8Fixer.__fixD247" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD247" /> <keyword name="Pep8Fixer.__fixE101" id="Pep8Fixer.__fixE101" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixE101" /> <keyword name="Pep8Fixer.__fixE121" id="Pep8Fixer.__fixE121" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixE121" /> <keyword name="Pep8Fixer.__fixE122" id="Pep8Fixer.__fixE122" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixE122" />
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html Fri Sep 27 18:36:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html Fri Sep 27 18:36:53 2013 +0200 @@ -96,11 +96,11 @@ <td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td> <td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td> </tr><tr> -<td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClass">__checkEricNoBlankBeforeAndAfterClass</a></td> -<td>Private method to check, that class docstrings have no blank line around them.</td> +<td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> +<td>Private method to check, that class and function/method docstrings have no blank line around them.</td> </tr><tr> -<td><a href="#Pep257Checker.__checkEricOneLiner">__checkEricOneLiner</a></td> -<td>Private method to check, that one-liner docstrings are on three lines (quotes, docstring, quotes).</td> +<td><a href="#Pep257Checker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td> +<td>Private method to check, that leading and trailing quotes are on a line by themselves.</td> </tr><tr> <td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td> <td>Private method to check, that docstrings contain an @return line.</td> @@ -381,12 +381,12 @@ <dd> context of the docstring (Pep257Context) </dd> -</dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass"></a> -<h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClass</h4> -<b>__checkEricNoBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) +</dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> +<h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4> +<b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>) <p> - Private method to check, that class docstrings have no blank line - around them. + Private method to check, that class and function/method docstrings + have no blank line around them. </p><dl> <dt><i>docstringContext</i></dt> <dd> @@ -395,12 +395,12 @@ <dd> context of the docstring (Pep257Context) </dd> -</dl><a NAME="Pep257Checker.__checkEricOneLiner" ID="Pep257Checker.__checkEricOneLiner"></a> -<h4>Pep257Checker.__checkEricOneLiner</h4> -<b>__checkEricOneLiner</b>(<i>docstringContext, context</i>) +</dl><a NAME="Pep257Checker.__checkEricQuotesOnSeparateLines" ID="Pep257Checker.__checkEricQuotesOnSeparateLines"></a> +<h4>Pep257Checker.__checkEricQuotesOnSeparateLines</h4> +<b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) <p> - Private method to check, that one-liner docstrings are on - three lines (quotes, docstring, quotes). + Private method to check, that leading and trailing quotes are on + a line by themselves. </p><dl> <dt><i>docstringContext</i></dt> <dd>
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html Fri Sep 27 18:36:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html Fri Sep 27 18:36:53 2013 +0200 @@ -85,7 +85,7 @@ <td>Private method to fix a single line docstring on multiple lines (D121).</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD131">__fixD131</a></td> -<td>Private method to fix a single line docstring on multiple lines (D121).</td> +<td>Private method to fix a docstring summary not ending with a period (D131).</td> </tr><tr> <td><a href="#Pep8Fixer.__fixD141">__fixD141</a></td> <td>Private method to fix a function/method docstring preceded by a blank line (D141).</td> @@ -102,6 +102,18 @@ <td><a href="#Pep8Fixer.__fixD145">__fixD145</a></td> <td>Private method to fix the last paragraph of a multi-line docstring not followed by a blank line (D143).</td> </tr><tr> +<td><a href="#Pep8Fixer.__fixD221">__fixD221</a></td> +<td>Private method to fix leading and trailing quotes of docstring not on separate lines (D221, D222).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD242">__fixD242</a></td> +<td>Private method to fix a class or function/method docstring preceded by a blank line (D242, D244).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD243">__fixD243</a></td> +<td>Private method to fix a class or function/method docstring followed by a blank line (D243, D245).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD247">__fixD247</a></td> +<td>Private method to fix a last paragraph of a docstring followed by a blank line (D247).</td> +</tr><tr> <td><a href="#Pep8Fixer.__fixE101">__fixE101</a></td> <td>Private method to fix obsolete tab usage and indentation errors (E101, E111, W191).</td> </tr><tr> @@ -363,7 +375,8 @@ <h4>Pep8Fixer.__fixD131</h4> <b>__fixD131</b>(<i>code, line, pos</i>) <p> - Private method to fix a single line docstring on multiple lines (D121). + Private method to fix a docstring summary not ending with a + period (D131). </p><dl> <dt><i>code</i></dt> <dd> @@ -522,6 +535,118 @@ a message for the fix (string) and an ID for a deferred fix (integer) </dd> +</dl><a NAME="Pep8Fixer.__fixD221" ID="Pep8Fixer.__fixD221"></a> +<h4>Pep8Fixer.__fixD221</h4> +<b>__fixD221</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix leading and trailing quotes of docstring + not on separate lines (D221, D222). +</p><dl> +<dt><i>code</i></dt> +<dd> +code of the issue (string) +</dd><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>apply=</i></dt> +<dd> +flag indicating, that the fix should be applied + (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) +</dd> +</dl><a NAME="Pep8Fixer.__fixD242" ID="Pep8Fixer.__fixD242"></a> +<h4>Pep8Fixer.__fixD242</h4> +<b>__fixD242</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a class or function/method docstring preceded + by a blank line (D242, D244). +</p><dl> +<dt><i>code</i></dt> +<dd> +code of the issue (string) +</dd><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>apply=</i></dt> +<dd> +flag indicating, that the fix should be applied + (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) +</dd> +</dl><a NAME="Pep8Fixer.__fixD243" ID="Pep8Fixer.__fixD243"></a> +<h4>Pep8Fixer.__fixD243</h4> +<b>__fixD243</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a class or function/method docstring followed + by a blank line (D243, D245). +</p><dl> +<dt><i>code</i></dt> +<dd> +code of the issue (string) +</dd><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>apply=</i></dt> +<dd> +flag indicating, that the fix should be applied + (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) +</dd> +</dl><a NAME="Pep8Fixer.__fixD247" ID="Pep8Fixer.__fixD247"></a> +<h4>Pep8Fixer.__fixD247</h4> +<b>__fixD247</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a last paragraph of a docstring followed + by a blank line (D247). +</p><dl> +<dt><i>code</i></dt> +<dd> +code of the issue (string) +</dd><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>apply=</i></dt> +<dd> +flag indicating, that the fix should be applied + (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) +</dd> </dl><a NAME="Pep8Fixer.__fixE101" ID="Pep8Fixer.__fixE101"></a> <h4>Pep8Fixer.__fixE101</h4> <b>__fixE101</b>(<i>code, line, pos</i>)
--- a/Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html Fri Sep 27 18:36:07 2013 +0200 +++ b/Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html Fri Sep 27 18:36:53 2013 +0200 @@ -93,8 +93,8 @@ <td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td> <td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td> </tr><tr> -<td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClass">__checkEricNoBlankBeforeAndAfterClass</a></td> -<td>Private method to check, that class docstrings have no blank line around them.</td> +<td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> +<td>Private method to check, that class and function/method docstrings have no blank line around them.</td> </tr><tr> <td><a href="#Pep257Checker.__checkEricOneLiner">__checkEricOneLiner</a></td> <td>Private method to check, that one-liner docstrings are on three lines (quotes, docstring, quotes).</td> @@ -359,12 +359,12 @@ <dd> context of the docstring (Pep257Context) </dd> -</dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClass"></a> -<h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClass</h4> -<b>__checkEricNoBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) +</dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> +<h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4> +<b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>) <p> - Private method to check, that class docstrings have no blank line - around them. + Private method to check, that class and function/method docstrings + have no blank line around them. </p><dl> <dt><i>docstringContext</i></dt> <dd>