Corrected some code style issues and regenerated the source docu.

Sun, 06 Nov 2016 13:39:36 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 06 Nov 2016 13:39:36 +0100
changeset 5291
e93d14b48c34
parent 5290
174dae2b91c3
child 5292
ac8b476ba122

Corrected some code style issues and regenerated the source docu.

APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditEditor.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditPlanEditor.html file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditCommitEditor.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditConfigDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditEditor.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditPlanEditor.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HisteditExtension/histedit.py file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric6.api	Sun Nov 06 13:31:38 2016 +0100
+++ b/APIs/Python3/eric6.api	Sun Nov 06 13:39:36 2016 +0100
@@ -3888,9 +3888,12 @@
 eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.codeRole?7
 eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.filenameRole?7
 eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.fixableRole?7
+eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.hasResults?7
 eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.ignoredRole?7
 eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.lineRole?7
 eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.messageRole?7
+eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.noFiles?7
+eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.noResults?7
 eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.on_buttonBox_clicked?4(button)
 eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked?4()
 eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.CodeStyleCheckerDialog.on_fixButton_clicked?4()
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html	Sun Nov 06 13:31:38 2016 +0100
+++ b/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html	Sun Nov 06 13:39:36 2016 +0100
@@ -48,7 +48,7 @@
 QDialog, Ui_CodeStyleCheckerDialog
 <h3>Class Attributes</h3>
 <table>
-<tr><td>availableFutures</td></tr><tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>ignoredRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>positionRole</td></tr>
+<tr><td>availableFutures</td></tr><tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>hasResults</td></tr><tr><td>ignoredRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>noFiles</td></tr><tr><td>noResults</td></tr><tr><td>positionRole</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
--- a/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html	Sun Nov 06 13:31:38 2016 +0100
+++ b/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html	Sun Nov 06 13:39:36 2016 +0100
@@ -162,7 +162,7 @@
 <td>When raising an exception, use "raise ValueError('message')".</td>
 </tr><tr>
 <td><a href="#read_config">read_config</a></td>
-<td>Read and parse configurations</td>
+<td>Read and parse configurations.</td>
 </tr><tr>
 <td><a href="#readlines">readlines</a></td>
 <td>Read the source code.</td>
@@ -432,7 +432,7 @@
 <h4>Checker.init_checker_state</h4>
 <b>init_checker_state</b>(<i>name, argument_names</i>)
 <p>
- Prepare custom state for the specific checker plugin.
+Prepare custom state for the specific checker plugin.
 </p><a NAME="Checker.maybe_check_physical" ID="Checker.maybe_check_physical"></a>
 <h4>Checker.maybe_check_physical</h4>
 <b>maybe_check_physical</b>(<i>token</i>)
@@ -1281,7 +1281,7 @@
 <h2>read_config</h2>
 <b>read_config</b>(<i>options, args, arglist, parser</i>)
 <p>
-Read and parse configurations
+Read and parse configurations.
 </p><p>
     If a config file is specified on the command line with the "--config"
     option, then only it is used for configuration.
--- a/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditEditor.html	Sun Nov 06 13:31:38 2016 +0100
+++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditEditor.html	Sun Nov 06 13:39:36 2016 +0100
@@ -21,9 +21,10 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditEditor</h1>
 <p>
-Module implementing the main script for histedit. Depending on the file
-name given by the Mercurial histedit command one of two possible dialogs
-will be shown.
+Module implementing the main script for histedit.
+</p><p>
+Depending on the file name given by the Mercurial histedit command one
+of two possible dialogs will be shown.
 </p>
 <h3>Global Attributes</h3>
 <table>
--- a/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditPlanEditor.html	Sun Nov 06 13:31:38 2016 +0100
+++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.HgHisteditPlanEditor.html	Sun Nov 06 13:39:36 2016 +0100
@@ -216,7 +216,12 @@
 <b>__createPlanItem</b>(<i>text</i>)
 <p>
         Private method to create an edit plan tree item.
-</p><a NAME="HgHisteditPlanEditor.__readFile" ID="HgHisteditPlanEditor.__readFile"></a>
+</p><dl>
+<dt><i>text</i> (str)</dt>
+<dd>
+line of text to be parsed
+</dd>
+</dl><a NAME="HgHisteditPlanEditor.__readFile" ID="HgHisteditPlanEditor.__readFile"></a>
 <h4>HgHisteditPlanEditor.__readFile</h4>
 <b>__readFile</b>(<i></i>)
 <p>
--- a/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditCommitEditor.py	Sun Nov 06 13:31:38 2016 +0100
+++ b/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditCommitEditor.py	Sun Nov 06 13:39:36 2016 +0100
@@ -7,6 +7,8 @@
 Module implementing a dialog to edit the commit message of a revision.
 """
 
+from __future__ import unicode_literals
+
 from PyQt5.QtCore import pyqtSlot, QCoreApplication
 from PyQt5.QtWidgets import QDialog
 
--- a/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditConfigDialog.py	Sun Nov 06 13:31:38 2016 +0100
+++ b/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditConfigDialog.py	Sun Nov 06 13:39:36 2016 +0100
@@ -7,6 +7,8 @@
 Module implementing a dialog to enter the histedit parameters.
 """
 
+from __future__ import unicode_literals
+
 from PyQt5.QtCore import pyqtSlot
 from PyQt5.QtWidgets import QDialog, QDialogButtonBox, QButtonGroup
 
--- a/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditEditor.py	Sun Nov 06 13:31:38 2016 +0100
+++ b/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditEditor.py	Sun Nov 06 13:39:36 2016 +0100
@@ -5,9 +5,10 @@
 #
 
 """
-Module implementing the main script for histedit. Depending on the file
-name given by the Mercurial histedit command one of two possible dialogs
-will be shown.
+Module implementing the main script for histedit.
+
+Depending on the file name given by the Mercurial histedit command one
+of two possible dialogs will be shown.
 """
 
 from __future__ import unicode_literals
--- a/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditPlanEditor.py	Sun Nov 06 13:31:38 2016 +0100
+++ b/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/HgHisteditPlanEditor.py	Sun Nov 06 13:39:36 2016 +0100
@@ -7,6 +7,8 @@
 Module implementing a dialog to edit the history modification plan.
 """
 
+from __future__ import unicode_literals
+
 from PyQt5.QtCore import pyqtSlot, QCoreApplication
 from PyQt5.QtWidgets import QDialog, QTreeWidgetItem, QComboBox
 
@@ -140,6 +142,9 @@
     def __createPlanItem(self, text):
         """
         Private method to create an edit plan tree item.
+        
+        @param text line of text to be parsed
+        @type str
         """
         if not text.lstrip():
             return
--- a/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/histedit.py	Sun Nov 06 13:31:38 2016 +0100
+++ b/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/histedit.py	Sun Nov 06 13:39:36 2016 +0100
@@ -52,9 +52,9 @@
         from .HgHisteditConfigDialog import HgHisteditConfigDialog
         res = False
         dlg = HgHisteditConfigDialog(self.vcs.hgGetTagsList(repodir),
-                            self.vcs.hgGetBranchesList(repodir),
-                            self.vcs.hgGetBookmarksList(repodir),
-                            rev)
+                                     self.vcs.hgGetBranchesList(repodir),
+                                     self.vcs.hgGetBookmarksList(repodir),
+                                     rev)
         if dlg.exec_() == QDialog.Accepted:
             rev, force, keep = dlg.getData()
             
@@ -76,7 +76,7 @@
             
             dia = HgDialog(
                 self.tr("Starting histedit session"),
-                self.vcs, 
+                self.vcs,
                 useClient=False)
             res = dia.startProcess(args, repodir, environment=env)
             if res:
@@ -111,7 +111,7 @@
         
         dia = HgDialog(
             self.tr("Continue histedit session"),
-            self.vcs, 
+            self.vcs,
             useClient=False)
         res = dia.startProcess(args, repodir, environment=env)
         if res:
@@ -146,7 +146,7 @@
         
         dia = HgDialog(
             self.tr("Abort histedit session"),
-            self.vcs, 
+            self.vcs,
             useClient=False)
         res = dia.startProcess(args, repodir, environment=env)
         if res:
@@ -182,7 +182,7 @@
         
         dia = HgDialog(
             self.tr("Edit Plan"),
-            self.vcs, 
+            self.vcs,
             useClient=False)
         res = dia.startProcess(args, repodir, environment=env)
         if res:

eric ide

mercurial