Regenerated source docu. Py2 comp.

Wed, 06 Nov 2013 19:50:24 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Wed, 06 Nov 2013 19:50:24 +0100
branch
Py2 comp.
changeset 3066
76a310bc7bba
parent 3065
070b35dde35e
child 3079
0233bbe9a9c4

Regenerated source docu.

Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Utilities.SyntaxCheck.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Utilities.__init__.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Utilities.compatibility_fixes.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Utilities.py2flakes.messages.html file | annotate | diff | comparison | revisions
Documentation/Source/index-eric5.Utilities.py2flakes.html file | annotate | diff | comparison | revisions
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Source/eric5.Utilities.SyntaxCheck.html	Tue Nov 05 22:23:38 2013 +0100
+++ b/Documentation/Source/eric5.Utilities.SyntaxCheck.html	Wed Nov 06 19:50:24 2013 +0100
@@ -110,7 +110,8 @@
 <h2>extractLineFlags</h2>
 <b>extractLineFlags</b>(<i>line, startComment="</i>)
 <p>
-    Function to extract flags starting and ending with '__' from a line comment.
+    Function to extract flags starting and ending with '__' from a line
+    comment.
 </p><dl>
 <dt><i>line</i></dt>
 <dd>
--- a/Documentation/Source/eric5.Utilities.__init__.html	Tue Nov 05 22:23:38 2013 +0100
+++ b/Documentation/Source/eric5.Utilities.__init__.html	Wed Nov 06 19:50:24 2013 +0100
@@ -426,9 +426,16 @@
 <dt><i>file</i></dt>
 <dd>
 source filename (string)
+</dd><dt><i>isPy2</i></dt>
+<dd>
+flag indicating if it's a Python 2 or 3 file (boolean)
 </dd><dt><i>checkFlakes=</i></dt>
 <dd>
 flag indicating to do a pyflakes check (boolean)
+</dd><dt><i>ignoreStarImportWarnings=</i></dt>
+<dd>
+flag if star import warnings should be
+        suppressed (boolean)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
--- a/Documentation/Source/eric5.Utilities.compatibility_fixes.html	Tue Nov 05 22:23:38 2013 +0100
+++ b/Documentation/Source/eric5.Utilities.compatibility_fixes.html	Wed Nov 06 19:50:24 2013 +0100
@@ -22,6 +22,7 @@
 <h1>eric5.Utilities.compatibility_fixes</h1>
 <p>
 Module implementing the open behavior of Python3 for use with Eric5.
+</p><p>
 The Eric5 used features are emulated only. The not emulated features
 should throw a NotImplementedError exception.
 </p>
@@ -103,13 +104,20 @@
 character encoding for reading/ writing (string)
 </dd><dt><i>errors=</i></dt>
 <dd>
-behavior for the character encoding ('strict', 'explicit', ...) (string)
+behavior for the character encoding ('strict',
+            'explicit', ...) (string)
 </dd><dt><i>newline=</i></dt>
 <dd>
 controls how universal newlines works (string)
 </dd><dt><i>closefd=</i></dt>
 <dd>
-close underlying file descriptor if given as file parameter (boolean)
+close underlying file descriptor if given as file
+            parameter (boolean)
+</dd>
+</dl><dl>
+<dt>Raises <b>NotImplementedError</b>:</dt>
+<dd>
+for not implemented method parameters
 </dd>
 </dl><a NAME="File.next" ID="File.next"></a>
 <h4>File.next</h4>
@@ -199,13 +207,20 @@
 character encoding for reading/ writing (string)
 </dd><dt><i>errors=</i></dt>
 <dd>
-behavior for the character encoding ('strict', 'explicit', ...) (string)
+behavior for the character encoding ('strict',
+        'explicit', ...) (string)
 </dd><dt><i>newline=</i></dt>
 <dd>
 controls how universal newlines works (string)
 </dd><dt><i>closefd=</i></dt>
 <dd>
-close underlying file descriptor if given as file parameter (boolean)
+close underlying file descriptor if given as file
+        parameter (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+Returns the new file object
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.Utilities.py2flakes.messages.html	Tue Nov 05 22:23:38 2013 +0100
+++ b/Documentation/Source/eric5.Utilities.py2flakes.messages.html	Wed Nov 06 19:50:24 2013 +0100
@@ -20,7 +20,9 @@
 </head>
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Utilities.py2flakes.messages</h1>
-
+<p>
+Module implementing the messages for py2flakes.
+</p>
 <h3>Global Attributes</h3>
 <table>
 <tr><td>None</td></tr>
@@ -47,7 +49,7 @@
 <td>Class defining the "Redefined" message.</td>
 </tr><tr>
 <td><a href="#RedefinedInListComp">RedefinedInListComp</a></td>
-<td></td>
+<td>Class defining the list comprehension redefinition.</td>
 </tr><tr>
 <td><a href="#RedefinedWhileUnused">RedefinedWhileUnused</a></td>
 <td>Class defining the "Redefined While Unused" message.</td>
@@ -378,7 +380,9 @@
 <hr /><hr />
 <a NAME="RedefinedInListComp" ID="RedefinedInListComp"></a>
 <h2>RedefinedInListComp</h2>
-
+<p>
+    Class defining the list comprehension redefinition.
+</p>
 <h3>Derived from</h3>
 Message
 <h3>Class Attributes</h3>
@@ -694,9 +698,9 @@
 </dd><dt><i>lineno</i></dt>
 <dd>
 line number (integer)
-</dd><dt><i>name</i></dt>
+</dd><dt><i>names</i></dt>
 <dd>
-name of the unused variable (string)
+names of the unused variable (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/index-eric5.Utilities.py2flakes.html	Tue Nov 05 22:23:38 2013 +0100
+++ b/Documentation/Source/index-eric5.Utilities.py2flakes.html	Wed Nov 06 19:50:24 2013 +0100
@@ -32,7 +32,7 @@
 <td></td>
 </tr><tr>
 <td><a href="eric5.Utilities.py2flakes.messages.html">messages</a></td>
-<td></td>
+<td>Module implementing the messages for py2flakes.</td>
 </tr>
 </table>
 </body></html>
\ No newline at end of file

eric ide

mercurial