Updated source docu.

Sat, 28 Sep 2013 17:24:44 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 28 Sep 2013 17:24:44 +0200
changeset 2950
d568932e5185
parent 2949
e8f41288a688
child 2951
2cef28b12399

Updated source docu.

Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.QScintilla.Shell.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html file | annotate | diff | comparison | revisions
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Sat Sep 28 17:24:00 2013 +0200
+++ b/Documentation/Help/source.qhp	Sat Sep 28 17:24:44 2013 +0200
@@ -7983,14 +7983,16 @@
       <keyword name="Pep257Checker.__checkEricBlankAfterSummary" id="Pep257Checker.__checkEricBlankAfterSummary" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkEricBlankAfterSummary" />
       <keyword name="Pep257Checker.__checkEricEndsWithPeriod" id="Pep257Checker.__checkEricEndsWithPeriod" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricEndsWithPeriod" />
       <keyword name="Pep257Checker.__checkEricEndsWithPeriod" id="Pep257Checker.__checkEricEndsWithPeriod" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkEricEndsWithPeriod" />
+      <keyword name="Pep257Checker.__checkEricException" id="Pep257Checker.__checkEricException" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricException" />
+      <keyword name="Pep257Checker.__checkEricException" id="Pep257Checker.__checkEricException" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkEricException" />
       <keyword name="Pep257Checker.__checkEricFunctionArguments" id="Pep257Checker.__checkEricFunctionArguments" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricFunctionArguments" />
       <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.__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.__checkEricQuotesOnSeparateLines" id="Pep257Checker.__checkEricQuotesOnSeparateLines" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.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" />
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html	Sat Sep 28 17:24:00 2013 +0200
+++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html	Sat Sep 28 17:24:44 2013 +0200
@@ -90,8 +90,11 @@
 <td><a href="#Pep257Checker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td>
 <td>Private method to check, that docstring summaries end with a period.</td>
 </tr><tr>
+<td><a href="#Pep257Checker.__checkEricException">__checkEricException</a></td>
+<td>Private method to check, that docstrings contain an &#64;exception line if they raise an exception and don't otherwise.</td>
+</tr><tr>
 <td><a href="#Pep257Checker.__checkEricFunctionArguments">__checkEricFunctionArguments</a></td>
-<td>Private method to check, that docstrings contain an @param line for each argument.</td>
+<td>Private method to check, that docstrings contain an &#64;param and/or &#64;keyparam line for each argument.</td>
 </tr><tr>
 <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>
@@ -103,7 +106,7 @@
 <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>
+<td>Private method to check, that docstrings contain an &#64;return line if they return anything and don't otherwise.</td>
 </tr><tr>
 <td><a href="#Pep257Checker.__checkFunctionDocstring">__checkFunctionDocstring</a></td>
 <td>Private method to check, that all public functions and methods have a docstring.</td>
@@ -353,12 +356,26 @@
 <dd>
 context of the docstring (Pep257Context)
 </dd>
+</dl><a NAME="Pep257Checker.__checkEricException" ID="Pep257Checker.__checkEricException"></a>
+<h4>Pep257Checker.__checkEricException</h4>
+<b>__checkEricException</b>(<i>docstringContext, context</i>)
+<p>
+        Private method to check, that docstrings contain an &#64;exception line
+        if they raise an exception and don't otherwise.
+</p><dl>
+<dt><i>docstringContext</i></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
 </dl><a NAME="Pep257Checker.__checkEricFunctionArguments" ID="Pep257Checker.__checkEricFunctionArguments"></a>
 <h4>Pep257Checker.__checkEricFunctionArguments</h4>
 <b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>)
 <p>
-        Private method to check, that docstrings contain an @param line
-        for each argument.
+        Private method to check, that docstrings contain an &#64;param and/or
+        &#64;keyparam line for each argument.
 </p><dl>
 <dt><i>docstringContext</i></dt>
 <dd>
@@ -413,7 +430,8 @@
 <h4>Pep257Checker.__checkEricReturn</h4>
 <b>__checkEricReturn</b>(<i>docstringContext, context</i>)
 <p>
-        Private method to check, that docstrings contain an @return line.
+        Private method to check, that docstrings contain an &#64;return line
+        if they return anything and don't otherwise.
 </p><dl>
 <dt><i>docstringContext</i></dt>
 <dd>
@@ -661,6 +679,9 @@
 <dt><i>context</i></dt>
 <dd>
 context data to get the docstring from (Pep257Context)
+</dd><dt><i>what</i></dt>
+<dd>
+string denoting what is being parsed (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
--- a/Documentation/Source/eric5.QScintilla.Shell.html	Sat Sep 28 17:24:00 2013 +0200
+++ b/Documentation/Source/eric5.QScintilla.Shell.html	Sat Sep 28 17:24:44 2013 +0200
@@ -53,7 +53,8 @@
 <dl>
 <dt>searchStringFound(found)</dt>
 <dd>
-emitted to indicate the search result (boolean)
+emitted to indicate the search
+        result (boolean)
 </dd>
 </dl>
 <h3>Derived from</h3>
@@ -247,7 +248,7 @@
 <td>Private slot to show the shell history dialog.</td>
 </tr><tr>
 <td><a href="#Shell.__startDebugClient">__startDebugClient</a></td>
-<td>Private slot to start a debug client accoding to the action triggered[()].</td>
+<td>Private slot to start a debug client according to the action triggered[()].</td>
 </tr><tr>
 <td><a href="#Shell.__useHistory">__useHistory</a></td>
 <td>Private method to display a command from the history.</td>
@@ -445,7 +446,8 @@
 <h4>Shell.__QScintillaLeftDeleteCommand</h4>
 <b>__QScintillaLeftDeleteCommand</b>(<i>method</i>)
 <p>
-        Private method to handle a QScintilla delete command working to the left.
+        Private method to handle a QScintilla delete command working to
+        the left.
 </p><dl>
 <dt><i>method</i></dt>
 <dd>
@@ -679,7 +681,8 @@
 <h4>Shell.__insertTextNoEcho</h4>
 <b>__insertTextNoEcho</b>(<i>s</i>)
 <p>
-        Private method to insert some text at the end of the buffer without echoing it.
+        Private method to insert some text at the end of the buffer without
+        echoing it.
 </p><dl>
 <dt><i>s</i></dt>
 <dd>
@@ -836,7 +839,8 @@
 <h4>Shell.__startDebugClient</h4>
 <b>__startDebugClient</b>(<i>action</i>)
 <p>
-        Private slot to start a debug client accoding to the action triggered[()].
+        Private slot to start a debug client according to the action
+        triggered[()].
 </p><dl>
 <dt><i>action</i></dt>
 <dd>
@@ -1124,7 +1128,8 @@
 <h4>Shell.reloadHistory</h4>
 <b>reloadHistory</b>(<i></i>)
 <p>
-        Public method to reload the history of the currently selected client type.
+        Public method to reload the history of the currently selected client
+        type.
 </p><a NAME="Shell.saveHistory" ID="Shell.saveHistory"></a>
 <h4>Shell.saveHistory</h4>
 <b>saveHistory</b>(<i>clientType</i>)
--- a/Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html	Sat Sep 28 17:24:00 2013 +0200
+++ b/Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html	Sat Sep 28 17:24:44 2013 +0200
@@ -87,8 +87,11 @@
 <td><a href="#Pep257Checker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td>
 <td>Private method to check, that docstring summaries end with a period.</td>
 </tr><tr>
+<td><a href="#Pep257Checker.__checkEricException">__checkEricException</a></td>
+<td>Private method to check, that docstrings contain an &#64;exception line if they raise an exception and don't otherwise.</td>
+</tr><tr>
 <td><a href="#Pep257Checker.__checkEricFunctionArguments">__checkEricFunctionArguments</a></td>
-<td>Private method to check, that docstrings contain an @param line for each argument.</td>
+<td>Private method to check, that docstrings contain an &#64;param and/or &#64;keyparam line for each argument.</td>
 </tr><tr>
 <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>
@@ -96,11 +99,11 @@
 <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>
+<td>Private method to check, that docstrings contain an &#64;return line if they return anything and don't otherwise.</td>
 </tr><tr>
 <td><a href="#Pep257Checker.__checkFunctionDocstring">__checkFunctionDocstring</a></td>
 <td>Private method to check, that all public functions and methods have a docstring.</td>
@@ -331,12 +334,26 @@
 <dd>
 context of the docstring (Pep257Context)
 </dd>
+</dl><a NAME="Pep257Checker.__checkEricException" ID="Pep257Checker.__checkEricException"></a>
+<h4>Pep257Checker.__checkEricException</h4>
+<b>__checkEricException</b>(<i>docstringContext, context</i>)
+<p>
+        Private method to check, that docstrings contain an &#64;exception line
+        if they raise an exception and don't otherwise.
+</p><dl>
+<dt><i>docstringContext</i></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
 </dl><a NAME="Pep257Checker.__checkEricFunctionArguments" ID="Pep257Checker.__checkEricFunctionArguments"></a>
 <h4>Pep257Checker.__checkEricFunctionArguments</h4>
 <b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>)
 <p>
-        Private method to check, that docstrings contain an @param line
-        for each argument.
+        Private method to check, that docstrings contain an &#64;param and/or
+        &#64;keyparam line for each argument.
 </p><dl>
 <dt><i>docstringContext</i></dt>
 <dd>
@@ -373,12 +390,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>
@@ -391,7 +408,8 @@
 <h4>Pep257Checker.__checkEricReturn</h4>
 <b>__checkEricReturn</b>(<i>docstringContext, context</i>)
 <p>
-        Private method to check, that docstrings contain an @return line.
+        Private method to check, that docstrings contain an &#64;return line
+        if they return anything and don't otherwise.
 </p><dl>
 <dt><i>docstringContext</i></dt>
 <dd>
@@ -639,6 +657,9 @@
 <dt><i>context</i></dt>
 <dd>
 context data to get the docstring from (Pep257Context)
+</dd><dt><i>what</i></dt>
+<dd>
+string denoting what is being parsed (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>

eric ide

mercurial