Continued correcting doc strings by using the new doc string checker.

Sun, 29 Sep 2013 15:08:57 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 29 Sep 2013 15:08:57 +0200
changeset 2962
d6c9d1ca2da4
parent 2961
e4e2efb4846a
child 2963
745d38097b7f

Continued correcting doc strings by using the new doc string checker.

Helpviewer/Network/SchemeAccessHandler.py file | annotate | diff | comparison | revisions
Helpviewer/WebPlugins/WebPluginInterface.py file | annotate | diff | comparison | revisions
Plugins/CheckerPlugins/Pep8/Pep8Fixer.py file | annotate | diff | comparison | revisions
Plugins/CheckerPlugins/Pep8/Pep8NamingChecker.py file | annotate | diff | comparison | revisions
Plugins/CheckerPlugins/Pep8/Pep8StatisticsDialog.py file | annotate | diff | comparison | revisions
Plugins/CheckerPlugins/Tabnanny/Tabnanny.py file | annotate | diff | comparison | revisions
Plugins/DocumentationPlugins/Ericdoc/EricdocConfigDialog.py file | annotate | diff | comparison | revisions
Plugins/PluginVcsMercurial.py file | annotate | diff | comparison | revisions
Plugins/PluginVcsPySvn.py file | annotate | diff | comparison | revisions
Plugins/PluginVcsSubversion.py file | annotate | diff | comparison | revisions
Plugins/PluginWizardE5MessageBox.py file | annotate | diff | comparison | revisions
Plugins/PluginWizardPyRegExp.py file | annotate | diff | comparison | revisions
Plugins/PluginWizardQColorDialog.py file | annotate | diff | comparison | revisions
Plugins/PluginWizardQFileDialog.py file | annotate | diff | comparison | revisions
Plugins/PluginWizardQFontDialog.py file | annotate | diff | comparison | revisions
Plugins/PluginWizardQInputDialog.py file | annotate | diff | comparison | revisions
Plugins/PluginWizardQMessageBox.py file | annotate | diff | comparison | revisions
Plugins/PluginWizardQRegExp.py file | annotate | diff | comparison | revisions
Plugins/PluginWizardQRegularExpression.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/BookmarksExtension/HgBookmarkDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/BookmarksExtension/HgBookmarksInOutDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/Config.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgAddSubrepositoryDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgAnnotateDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgArchiveDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgClient.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgExportDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectHelper.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgMultiRevisionSelectionDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgPhaseDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/HgTagBranchListDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/PurgeExtension/purge.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesListAllGuardsDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesNewPatchDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesQueueManagementDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/QueuesExtension/ProjectHelper.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/QueuesExtension/queues.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/__init__.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsMercurial/hg.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsPySvn/Config.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsPySvn/SvnDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsPySvn/SvnLogBrowserDialog.py file | annotate | diff | comparison | revisions
Plugins/VcsPlugins/vcsPySvn/__init__.py file | annotate | diff | comparison | revisions
eric5.e4p file | annotate | diff | comparison | revisions
--- a/Helpviewer/Network/SchemeAccessHandler.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Helpviewer/Network/SchemeAccessHandler.py	Sun Sep 29 15:08:57 2013 +0200
@@ -8,7 +8,6 @@
 """
 
 from PyQt4.QtCore import QObject
-from PyQt4.QtNetwork import QNetworkReply
 
 
 class SchemeAccessHandler(QObject):
@@ -32,9 +31,8 @@
         @param request reference to the request object (QNetworkRequest)
         @param outgoingData reference to an IODevice containing data to be sent
             (QIODevice)
-        @return reference to the created reply object (QNetworkReply)
+        @ireturn reference to the created reply object (QNetworkReply)
         @exception NotImplementedError raised to indicate that the method must
             be implemented by a subclass
         """
         raise NotImplementedError()
-        return QNetworkReply()
--- a/Helpviewer/WebPlugins/WebPluginInterface.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Helpviewer/WebPlugins/WebPluginInterface.py	Sun Sep 29 15:08:57 2013 +0200
@@ -7,9 +7,6 @@
 Module implementing the web plug-in interface.
 """
 
-from PyQt4.QtGui import QWidget
-from PyQt4.QtWebKit import QWebPluginFactory
-
 
 class WebPluginInterface(object):
     """
@@ -19,12 +16,11 @@
         """
         Public method to create a meta plug-in object containing plug-in info.
         
-        @return meta plug-in object (QWebPluginFactory.Plugin)
+        @ireturn meta plug-in object (QWebPluginFactory.Plugin)
         @exception NotImplementedError raised to indicate that this method
             must be implemented by subclasses
         """
         raise NotImplementedError
-        return QWebPluginFactory.Plugin()
     
     def create(self, mimeType, url, argumentNames, argumentValues):
         """
@@ -34,12 +30,11 @@
         @param url URL for the plug-in (QUrl)
         @param argumentNames list of argument names (list of strings)
         @param argumentValues list of argument values (list of strings)
-        @return reference to the created object (QWidget)
+        @ireturn reference to the created object (QWidget)
         @exception NotImplementedError raised to indicate that this method
             must be implemented by subclasses
         """
         raise NotImplementedError
-        return QWidget()
     
     def configure(self):
         """
--- a/Plugins/CheckerPlugins/Pep8/Pep8Fixer.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/CheckerPlugins/Pep8/Pep8Fixer.py	Sun Sep 29 15:08:57 2013 +0200
@@ -2584,7 +2584,7 @@
         Private method to remove multiline-related code that will cause syntax
         error.
         
-        @param line code line to work on (string)
+        @param text code line to work on (string)
         @return normalized code line (string)
         """
         for quote in '\'"':
--- a/Plugins/CheckerPlugins/Pep8/Pep8NamingChecker.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/CheckerPlugins/Pep8/Pep8NamingChecker.py	Sun Sep 29 15:08:57 2013 +0200
@@ -237,7 +237,7 @@
     
     def __error(self, node, code):
         """
-        Private method to build the error information
+        Private method to build the error information.
         
         @param node AST node to report an error for
         @param code error code to report (string)
@@ -272,6 +272,7 @@
         Private class to check the given node for a name to be avoided (N831).
         
         @param node AST note to check
+        @param parents list of parent nodes
         @return tuple giving line number, offset within line and error code
             (integer, integer, string)
         """
@@ -307,6 +308,7 @@
         Classes for internal use have a leading underscore in addition.
         
         @param node AST note to check
+        @param parents list of parent nodes
         @return tuple giving line number, offset within line and error code
             (integer, integer, string)
         """
@@ -325,6 +327,7 @@
         (e.g. threading.py), to retain backwards compatibility.
         
         @param node AST note to check
+        @param parents list of parent nodes
         @return tuple giving line number, offset within line and error code
             (integer, integer, string)
         """
@@ -344,6 +347,7 @@
         first argument. A method should have 'self' as the first argument.
         
         @param node AST note to check
+        @param parents list of parent nodes
         @return tuple giving line number, offset within line and error code
             (integer, integer, string)
         """
@@ -388,6 +392,7 @@
         Local variables in functions should be lowercase.
         
         @param node AST note to check
+        @param parents list of parent nodes
         @return tuple giving line number, offset within line and error code
             (integer, integer, string)
         """
@@ -413,6 +418,7 @@
         Module and package names should be lowercase.
         
         @param node AST note to check
+        @param parents list of parent nodes
         @return tuple giving line number, offset within line and error code
             (integer, integer, string)
         """
@@ -434,6 +440,7 @@
         naming convention (N811, N812, N813, N814).
         
         @param node AST note to check
+        @param parents list of parent nodes
         @return tuple giving line number, offset within line and error code
             (integer, integer, string)
         """
--- a/Plugins/CheckerPlugins/Pep8/Pep8StatisticsDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/CheckerPlugins/Pep8/Pep8StatisticsDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -29,7 +29,7 @@
         """
         Constructor
         
-        @param dictionary with the statistical data
+        @param statistics dictionary with the statistical data
         @param parent reference to the parent widget (QWidget)
         """
         super().__init__(parent)
--- a/Plugins/CheckerPlugins/Tabnanny/Tabnanny.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/CheckerPlugins/Tabnanny/Tabnanny.py	Sun Sep 29 15:08:57 2013 +0200
@@ -53,6 +53,8 @@
 
 class NannyNag(Exception):
     """
+    Class implementing an exception for indentation issues.
+    
     Raised by tokeneater() if detecting an ambiguous indent.
     Captured and handled in check().
     """
@@ -343,6 +345,7 @@
     Function processing all tokens generated by a tokenizer run.
     
     @param tokens list of tokens
+    @exception NannyNag raised to indicate an indentation error
     """
     INDENT = tokenize.INDENT
     DEDENT = tokenize.DEDENT
--- a/Plugins/DocumentationPlugins/Ericdoc/EricdocConfigDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/DocumentationPlugins/Ericdoc/EricdocConfigDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -456,7 +456,7 @@
         self.__checkQtHelpOptions()
     
     @pyqtSlot(str)
-    def on_qtHelpTitleEdit_textChanged(self, p0):
+    def on_qtHelpTitleEdit_textChanged(self, txt):
         """
         Private slot to check the title.
         
--- a/Plugins/PluginVcsMercurial.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginVcsMercurial.py	Sun Sep 29 15:08:57 2013 +0200
@@ -104,6 +104,7 @@
     """
     Module function to create the configuration page.
     
+    @param configDlg reference to the configuration dialog (QDialog)
     @return reference to the configuration page
     """
     global mercurialCfgPluginObject
--- a/Plugins/PluginVcsPySvn.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginVcsPySvn.py	Sun Sep 29 15:08:57 2013 +0200
@@ -98,6 +98,7 @@
     """
     Module function to create the configuration page.
     
+    @param configDlg reference to the configuration dialog (QDialog)
     @return reference to the configuration page
     """
     global subversionCfgPluginObject
@@ -189,7 +190,6 @@
         Public method to retrieve the various settings.
         
         @param key the key of the value to get
-        @param prefClass preferences class used as the storage area
         @return the requested refactoring setting
         """
         if key in ["StopLogOnCopy"]:
@@ -210,7 +210,6 @@
         
         @param key the key of the setting to be set
         @param value the value to be set
-        @param prefClass preferences class used as the storage area
         """
         Preferences.Prefs.settings.setValue("Subversion/" + key, value)
     
--- a/Plugins/PluginVcsSubversion.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginVcsSubversion.py	Sun Sep 29 15:08:57 2013 +0200
@@ -104,6 +104,7 @@
     """
     Module function to create the configuration page.
     
+    @param configDlg reference to the configuration dialog (QDialog)
     @return reference to the configuration page
     """
     global subversionCfgPluginObject
--- a/Plugins/PluginWizardE5MessageBox.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginWizardE5MessageBox.py	Sun Sep 29 15:08:57 2013 +0200
@@ -112,7 +112,7 @@
         
     def __handle(self):
         """
-        Private method to handle the wizards action
+        Private method to handle the wizards action.
         """
         editor = e5App().getObject("ViewManager").activeWindow()
         
--- a/Plugins/PluginWizardPyRegExp.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginWizardPyRegExp.py	Sun Sep 29 15:08:57 2013 +0200
@@ -112,7 +112,7 @@
         
     def __handle(self):
         """
-        Private method to handle the wizards action
+        Private method to handle the wizards action.
         """
         editor = e5App().getObject("ViewManager").activeWindow()
         
--- a/Plugins/PluginWizardQColorDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginWizardQColorDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -112,7 +112,7 @@
         
     def __handle(self):
         """
-        Private method to handle the wizards action
+        Private method to handle the wizards action.
         """
         editor = e5App().getObject("ViewManager").activeWindow()
         
--- a/Plugins/PluginWizardQFileDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginWizardQFileDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -112,7 +112,7 @@
         
     def __handle(self):
         """
-        Private method to handle the wizards action
+        Private method to handle the wizards action.
         """
         editor = e5App().getObject("ViewManager").activeWindow()
         
--- a/Plugins/PluginWizardQFontDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginWizardQFontDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -112,7 +112,7 @@
         
     def __handle(self):
         """
-        Private method to handle the wizards action
+        Private method to handle the wizards action.
         """
         editor = e5App().getObject("ViewManager").activeWindow()
         
--- a/Plugins/PluginWizardQInputDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginWizardQInputDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -112,7 +112,7 @@
         
     def __handle(self):
         """
-        Private method to handle the wizards action
+        Private method to handle the wizards action.
         """
         editor = e5App().getObject("ViewManager").activeWindow()
         
--- a/Plugins/PluginWizardQMessageBox.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginWizardQMessageBox.py	Sun Sep 29 15:08:57 2013 +0200
@@ -112,7 +112,7 @@
         
     def __handle(self):
         """
-        Private method to handle the wizards action
+        Private method to handle the wizards action.
         """
         editor = e5App().getObject("ViewManager").activeWindow()
         
--- a/Plugins/PluginWizardQRegExp.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginWizardQRegExp.py	Sun Sep 29 15:08:57 2013 +0200
@@ -112,7 +112,7 @@
         
     def __handle(self):
         """
-        Private method to handle the wizards action
+        Private method to handle the wizards action.
         """
         editor = e5App().getObject("ViewManager").activeWindow()
         
--- a/Plugins/PluginWizardQRegularExpression.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/PluginWizardQRegularExpression.py	Sun Sep 29 15:08:57 2013 +0200
@@ -112,7 +112,7 @@
         
     def __handle(self):
         """
-        Private method to handle the wizards action
+        Private method to handle the wizards action.
         """
         editor = e5App().getObject("ViewManager").activeWindow()
         
--- a/Plugins/VcsPlugins/vcsMercurial/BookmarksExtension/HgBookmarkDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/BookmarksExtension/HgBookmarkDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -91,6 +91,8 @@
     def on_nameCombo_activated(self, txt):
         """
         Private slot to handle changes of the selected bookmark name.
+        
+        @param txt selected combo entry (string)
         """
         self.__updateOK()
         self.__updateBookmarksCombo()
--- a/Plugins/VcsPlugins/vcsMercurial/BookmarksExtension/HgBookmarksInOutDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/BookmarksExtension/HgBookmarksInOutDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -35,6 +35,7 @@
         @param mode mode of the dialog (HgBookmarksInOutDialog.INCOMING,
             HgBookmarksInOutDialog.OUTGOING)
         @param parent reference to the parent widget (QWidget)
+        @exception ValueError raised to indicate an invalid dialog mode
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -87,6 +88,7 @@
         Public slot to start the bookmarks command.
         
         @param path name of directory to be listed (string)
+        @exception ValueError raised to indicate an invalid dialog mode
         """
         self.errorGroup.hide()
         
--- a/Plugins/VcsPlugins/vcsMercurial/Config.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/Config.py	Sun Sep 29 15:08:57 2013 +0200
@@ -4,7 +4,7 @@
 #
 
 """
-Module defining configuration variables for the Mercurial package
+Module defining configuration variables for the Mercurial package.
 """
 
 # Available protocols fpr the repository URL
--- a/Plugins/VcsPlugins/vcsMercurial/HgAddSubrepositoryDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/HgAddSubrepositoryDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -27,6 +27,7 @@
         """
         Constructor
         
+        @param projectPath project directory name (string)
         @param parent reference to the parent widget (QWidget)
         """
         super().__init__(parent)
--- a/Plugins/VcsPlugins/vcsMercurial/HgAnnotateDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/HgAnnotateDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -41,7 +41,8 @@
         self.vcs = vcs
         self.__hgClient = vcs.getClient()
         
-        self.annotateList.headerItem().setText(self.annotateList.columnCount(), "")
+        self.annotateList.headerItem().setText(
+            self.annotateList.columnCount(), "")
         font = QFont(self.annotateList.font())
         if Utilities.isWindowsPlatform():
             font.setFamily("Lucida Console")
@@ -144,7 +145,8 @@
     
     def __finish(self):
         """
-        Private slot called when the process finished or the user pressed the button.
+        Private slot called when the process finished or the user pressed
+        the button.
         """
         if self.process is not None and \
            self.process.state() != QProcess.NotRunning:
@@ -158,7 +160,8 @@
         self.buttonBox.button(QDialogButtonBox.Close).setEnabled(True)
         self.buttonBox.button(QDialogButtonBox.Cancel).setEnabled(False)
         self.buttonBox.button(QDialogButtonBox.Close).setDefault(True)
-        self.buttonBox.button(QDialogButtonBox.Close).setFocus(Qt.OtherFocusReason)
+        self.buttonBox.button(QDialogButtonBox.Close).setFocus(
+            Qt.OtherFocusReason)
         
         self.process = None
         
@@ -201,10 +204,12 @@
         @param changeset changeset string (string)
         @param author author of the change (string)
         @param date date of the tag (string)
-        @param name name (path) of the tag (string)
+        @param text name (path) of the tag (string)
         """
-        itm = QTreeWidgetItem(self.annotateList,
-            [revision, changeset, author, date, "{0:d}".format(self.lineno), text])
+        itm = QTreeWidgetItem(
+            self.annotateList,
+            [revision, changeset, author, date, "{0:d}".format(self.lineno),
+             text])
         self.lineno += 1
         itm.setTextAlignment(0, Qt.AlignRight)
         itm.setTextAlignment(4, Qt.AlignRight)
@@ -219,7 +224,8 @@
         self.process.setReadChannel(QProcess.StandardOutput)
         
         while self.process.canReadLine():
-            s = str(self.process.readLine(), self.__ioEncoding, 'replace').strip()
+            s = str(self.process.readLine(), self.__ioEncoding, 'replace')\
+                .strip()
             self.__processOutputLine(s)
     
     def __processOutputLine(self, line):
--- a/Plugins/VcsPlugins/vcsMercurial/HgArchiveDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/HgArchiveDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -82,6 +82,8 @@
     def on_archiveEdit_textChanged(self, archive):
         """
         Private slot to handle changes of the archive name.
+        
+        @param archive name of the archive (string)
         """
         self.buttonBox.button(QDialogButtonBox.Ok).setEnabled(archive != "")
     
--- a/Plugins/VcsPlugins/vcsMercurial/HgClient.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/HgClient.py	Sun Sep 29 15:08:57 2013 +0200
@@ -10,7 +10,8 @@
 import struct
 import io
 
-from PyQt4.QtCore import QProcess, QObject, QByteArray, QCoreApplication, QThread
+from PyQt4.QtCore import QProcess, QObject, QByteArray, QCoreApplication, \
+    QThread
 from PyQt4.QtGui import QDialog
 
 from .HgUtilities import prepareProcess
@@ -134,8 +135,9 @@
         msg = msg.split("\n")
         
         if not msg[0].startswith("capabilities: "):
-            return False, self.trUtf8("Bad 'hello' message, expected 'capabilities: '"
-                                      " but got '{0}'.").format(msg[0])
+            return False, self.trUtf8(
+                "Bad 'hello' message, expected 'capabilities: '"
+                " but got '{0}'.").format(msg[0])
         self.__capabilities = msg[0][len('capabilities: '):]
         if not self.__capabilities:
             return False, self.trUtf8("'capabilities' message did not contain"
@@ -146,8 +148,9 @@
             return False, "'capabilities' did not contain 'runcommand'."
         
         if not msg[1].startswith("encoding: "):
-            return False, self.trUtf8("Bad 'hello' message, expected 'encoding: '"
-                                      " but got '{0}'.").format(msg[1])
+            return False, self.trUtf8(
+                "Bad 'hello' message, expected 'encoding: '"
+                " but got '{0}'.").format(msg[1])
         encoding = msg[1][len('encoding: '):]
         if not encoding:
             return False, self.trUtf8("'encoding' message did not contain"
@@ -206,7 +209,8 @@
         """
         if not isinstance(data, bytes):
             data = data.encode(self.__encoding)
-        self.__server.write(QByteArray(struct.pack(HgClient.InputFormat, len(data))))
+        self.__server.write(
+            QByteArray(struct.pack(HgClient.InputFormat, len(data))))
         self.__server.write(QByteArray(data))
         self.__server.waitForBytesWritten()
     
@@ -216,13 +220,15 @@
         
         @param args list of arguments for the command (list of string)
         @param inputChannels dictionary of input channels. The dictionary must
-            have the keys 'I' and 'L' and each entry must be a function receiving
-            the number of bytes to write.
-        @param outputChannels dictionary of output channels. The dictionary must
-            have the keys 'o' and 'e' and each entry must be a function receiving
-            the data.
-        @return result code of the command, -1 if the command server wasn't started or
-            -10, if the command was canceled (integer)
+            have the keys 'I' and 'L' and each entry must be a function
+            receiving the number of bytes to write.
+        @param outputChannels dictionary of output channels. The dictionary
+            must have the keys 'o' and 'e' and each entry must be a function
+            receiving the data.
+        @return result code of the command, -1 if the command server wasn't
+            started or -10, if the command was canceled (integer)
+        @exception RuntimeError raised to indicate an unexpected command
+            channel
         """
         if not self.__started:
             return -1
@@ -275,6 +281,7 @@
         
         @param size maximum length of the requested input (integer)
         @param message message sent by the server (string)
+        @return data entered by the user (string)
         """
         from .HgClientPromptDialog import HgClientPromptDialog
         input = ""
@@ -283,7 +290,8 @@
             input = dlg.getInput() + '\n'
         return input
     
-    def runcommand(self, args, prompt=None, input=None, output=None, error=None):
+    def runcommand(self, args, prompt=None, input=None, output=None,
+                   error=None):
         """
         Public method to execute a command via the command server.
         
@@ -295,10 +303,11 @@
             It receives the max number of bytes to return.
         @keyparam output function receiving the data from the server (string).
             If a prompt function is given, this parameter will be ignored.
-        @keyparam error function receiving error messages from the server (string)
-        @return output and errors of the command server (string). In case output
-            and/or error functions were given, the respective return value will
-            be an empty string.
+        @keyparam error function receiving error messages from the server
+            (string)
+        @return output and errors of the command server (string). In case
+            output and/or error functions were given, the respective return
+            value will be an empty string.
         """
         self.__commandRunning = True
         outputChannels = {}
@@ -359,6 +368,8 @@
     def wasCanceled(self):
         """
         Public method to check, if the last command was canceled.
+        
+        @return flag indicating the cancel state (boolean)
         """
         return self.__cancel
     
@@ -368,3 +379,4 @@
         
         @return flag indicating the execution of a command (boolean)
         """
+        return self.__commandRunning
--- a/Plugins/VcsPlugins/vcsMercurial/HgExportDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/HgExportDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -57,7 +57,7 @@
         self.buttonBox.button(QDialogButtonBox.Ok).setEnabled(enabled)
     
     @pyqtSlot(str)
-    def on_directoryEdit_textChanged(self, p0):
+    def on_directoryEdit_textChanged(self, txt):
         """
         Private slot to react on changes of the export directory edit.
         
@@ -80,7 +80,7 @@
             self.directoryEdit.setText(Utilities.toNativeSeparators(dn))
     
     @pyqtSlot(str)
-    def on_patternEdit_textChanged(self, p0):
+    def on_patternEdit_textChanged(self, txt):
         """
         Private slot to react on changes of the export file name pattern edit.
         
@@ -92,8 +92,6 @@
     def on_changesetsEdit_textChanged(self):
         """
         Private slot to react on changes of the changesets edit.
-        
-        @param txt contents of the line edit (string)
         """
         self.__updateOK()
     
@@ -101,14 +99,16 @@
         """
         Public method to retrieve the export data.
         
-        @return tuple naming the output file name, the list of revisions to export,
-            and flags indicating to compare against the second parent, to treat all
-            files as text, to omit dates in the diff headers and to use the git extended
-            diff format (string, list of strings, boolean, boolean, boolean, boolean)
+        @return tuple naming the output file name, the list of revisions to
+            export, and flags indicating to compare against the second parent,
+            to treat all files as text, to omit dates in the diff headers and
+            to use the git extended diff format (string, list of strings,
+            boolean, boolean, boolean, boolean)
         """
         return (
-            os.path.join(Utilities.toNativeSeparators(self.directoryEdit.text()),
-                         self.patternEdit.text()),
+            os.path.join(
+                Utilities.toNativeSeparators(self.directoryEdit.text()),
+                self.patternEdit.text()),
             self.changesetsEdit.toPlainText().splitlines(),
             self.switchParentCheckBox.isChecked(),
             self.textCheckBox.isChecked(),
--- a/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectHelper.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectHelper.py	Sun Sep 29 15:08:57 2013 +0200
@@ -62,7 +62,7 @@
         Note: Derived class must implement this method.
         
         @param mainMenu reference to the main menu (QMenu)
-        @return populated menu (QMenu)
+        @ireturn populated menu (QMenu)
         @exception NotImplementedError raised if the class has not been reimplemente
         """
         raise NotImplementedError
@@ -73,7 +73,7 @@
         
         Note: Derived class must implement this method.
         
-        @return title of the menu (string)
+        @ireturn title of the menu (string)
         @exception NotImplementedError raised if the class has not been reimplemente
         """
         raise NotImplementedError
--- a/Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -1257,7 +1257,9 @@
     @pyqtSlot(bool)
     def on_stopCheckBox_clicked(self, checked):
         """
-        Private slot called, when the stop on copy/move checkbox is clicked
+        Private slot called, when the stop on copy/move checkbox is clicked.
+        
+        @param checked flag indicating the state of the check box (boolean)
         """
         self.vcs.getPlugin().setPreferences("StopLogOnCopy",
                                             self.stopCheckBox.isChecked())
--- a/Plugins/VcsPlugins/vcsMercurial/HgMultiRevisionSelectionDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/HgMultiRevisionSelectionDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -106,8 +106,6 @@
     def on_changesetsEdit_textChanged(self):
         """
         Private slot to handle changes of the Changesets edit.
-        
-        @param txt text of the edit (string)
         """
         self.__updateOK()
     
--- a/Plugins/VcsPlugins/vcsMercurial/HgPhaseDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/HgPhaseDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -52,6 +52,8 @@
     def on_phaseCombo_activated(self, txt):
         """
         Private slot to react upon changes of the phase.
+        
+        @param txt activated entry (string)
         """
         self.__updateOk()
     
--- a/Plugins/VcsPlugins/vcsMercurial/HgTagBranchListDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/HgTagBranchListDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -10,8 +10,8 @@
 import os
 
 from PyQt4.QtCore import pyqtSlot, QProcess, Qt, QTimer, QCoreApplication
-from PyQt4.QtGui import QDialog, QDialogButtonBox, QHeaderView, QTreeWidgetItem, \
-    QLineEdit
+from PyQt4.QtGui import QDialog, QDialogButtonBox, QHeaderView, \
+    QTreeWidgetItem, QLineEdit
 
 from E5Gui import E5MessageBox
 
@@ -77,9 +77,10 @@
         
         @param path name of directory to be listed (string)
         @param tags flag indicating a list of tags is requested
-                (False = branches, True = tags)
-        @param tagsList reference to string list receiving the tags (list of strings)
-        @param allsTagsList reference to string list all tags (list of strings)
+            (False = branches, True = tags)
+        @param tagsList reference to string list receiving the tags
+            (list of strings)
+        @param allTagsList reference to string list all tags (list of strings)
         """
         self.errorGroup.hide()
         
@@ -143,7 +144,8 @@
     
     def __finish(self):
         """
-        Private slot called when the process finished or the user pressed the button.
+        Private slot called when the process finished or the user pressed
+        the button.
         """
         if self.process is not None and \
            self.process.state() != QProcess.NotRunning:
@@ -157,7 +159,8 @@
         self.buttonBox.button(QDialogButtonBox.Close).setEnabled(True)
         self.buttonBox.button(QDialogButtonBox.Cancel).setEnabled(False)
         self.buttonBox.button(QDialogButtonBox.Close).setDefault(True)
-        self.buttonBox.button(QDialogButtonBox.Close).setFocus(Qt.OtherFocusReason)
+        self.buttonBox.button(QDialogButtonBox.Close).setFocus(
+            Qt.OtherFocusReason)
         
         self.process = None
         
--- a/Plugins/VcsPlugins/vcsMercurial/PurgeExtension/purge.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/PurgeExtension/purge.py	Sun Sep 29 15:08:57 2013 +0200
@@ -44,7 +44,8 @@
         Public method to get a list of files/directories being purged.
         
         @param repodir directory name of the repository (string)
-        @param all flag indicating to delete all files including ignored ones (boolean)
+        @param all flag indicating to delete all files including ignored ones
+            (boolean)
         @return name of the current patch (string)
         """
         purgeEntries = []
@@ -80,25 +81,28 @@
         Public method to purge files and directories not tracked by Mercurial.
         
         @param name file/directory name (string)
-        @param all flag indicating to delete all files including ignored ones (boolean)
+        @param all flag indicating to delete all files including ignored ones
+            (boolean)
         """
         # find the root of the repo
         repodir = self.vcs.splitPath(name)[0]
         while not os.path.isdir(os.path.join(repodir, self.vcs.adminDir)):
             repodir = os.path.dirname(repodir)
             if os.path.splitdrive(repodir)[1] == os.sep:
-                return False
+                return
         
         if all:
             title = self.trUtf8("Purge All Files")
-            message = self.trUtf8("""Do really want to delete all files not tracked by"""
-                                  """ Mercurial (including ignored ones)?""")
+            message = self.trUtf8(
+                """Do really want to delete all files not tracked by"""
+                """ Mercurial (including ignored ones)?""")
         else:
             title = self.trUtf8("Purge Files")
-            message = self.trUtf8("""Do really want to delete files not tracked by"""
-                                  """ Mercurial?""")
+            message = self.trUtf8(
+                """Do really want to delete files not tracked by Mercurial?""")
         entries = self.__getEntries(repodir, all)
-        from UI.DeleteFilesConfirmationDialog import DeleteFilesConfirmationDialog
+        from UI.DeleteFilesConfirmationDialog import \
+            DeleteFilesConfirmationDialog
         dlg = DeleteFilesConfirmationDialog(None, title, message, entries)
         if dlg.exec_() == QDialog.Accepted:
             args = []
@@ -117,14 +121,15 @@
         Public method to list files and directories not tracked by Mercurial.
         
         @param name file/directory name (string)
-        @param all flag indicating to list all files including ignored ones (boolean)
+        @param all flag indicating to list all files including ignored ones
+            (boolean)
         """
         # find the root of the repo
         repodir = self.vcs.splitPath(name)[0]
         while not os.path.isdir(os.path.join(repodir, self.vcs.adminDir)):
             repodir = os.path.dirname(repodir)
             if os.path.splitdrive(repodir)[1] == os.sep:
-                return False
+                return
         
         entries = self.__getEntries(repodir, all)
         from .HgPurgeListDialog import HgPurgeListDialog
--- a/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesListAllGuardsDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesListAllGuardsDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -26,6 +26,7 @@
         """
         Constructor
         
+        @param vcs reference to the VCS object (Hg)
         @param parent reference to the parent widget (QWidget)
         """
         super().__init__(parent)
@@ -68,8 +69,8 @@
             if procStarted:
                 finished = process.waitForFinished(30000)
                 if finished and process.exitCode() == 0:
-                    output = \
-                        str(process.readAllStandardOutput(), ioEncoding, 'replace')
+                    output = str(
+                        process.readAllStandardOutput(), ioEncoding, 'replace')
         
         if output:
             guardsDict = {}
--- a/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesNewPatchDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesNewPatchDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -28,6 +28,7 @@
             HgQueuesNewPatchDialog.REFRESH_MODE)
         @param message text to set as the commit message (string)
         @param parent reference to the parent widget (QWidget)
+        @exception ValueError raised to indicate an invalid dialog mode
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -78,8 +79,6 @@
     def on_messageEdit_textChanged(self):
         """
         Private slot to handle changes of the patch message.
-        
-        @param txt text of the edit (string)
         """
         self.__updateUI()
     
--- a/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesQueueManagementDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesQueueManagementDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -37,6 +37,7 @@
         @param repodir name of the repository directory (string)
         @param vcs reference to the vcs object
         @param parent reference to the parent widget (QWidget)
+        @exception ValueError raised to indicate an invalid dialog mode
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -122,6 +123,8 @@
     def on_nameEdit_textChanged(self, txt):
         """
         Private slot to handle changes of the entered queue name.
+        
+        @param txt text of the edit (string)
         """
         if self.__mode == HgQueuesQueueManagementDialog.NAME_INPUT:
             self.buttonBox.button(QDialogButtonBox.Ok).setEnabled(txt != "")
--- a/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/ProjectHelper.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/ProjectHelper.py	Sun Sep 29 15:08:57 2013 +0200
@@ -747,7 +747,6 @@
         @keyparam named flag indicating to push/pop until a named patch
             is at the top of the stack (boolean)
         @keyparam force flag indicating a forceful pop (boolean)
-        @return flag indicating that the project should be reread (boolean)
         """
         shouldReopen = self.vcs.getExtensionObject("mq")\
             .hgQueuePushPopPatches(name, operation=operation, all=all, named=named,
--- a/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/queues.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/queues.py	Sun Sep 29 15:08:57 2013 +0200
@@ -83,6 +83,7 @@
             (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST)
         @param withSummary flag indicating to get a summary as well (boolean)
         @return list of patches (list of string)
+        @exception ValueError raised to indicate an invalid patch list type
         """
         patchesList = []
         
@@ -357,6 +358,7 @@
             is at the top of the stack (boolean)
         @keyparam force flag indicating a forceful pop (boolean)
         @return flag indicating that the project should be reread (boolean)
+        @exception ValueError raised to indicate an invalid operation
         """
         # find the root of the repo
         repodir = self.vcs.splitPath(name)[0]
@@ -811,6 +813,7 @@
         @param name file/directory name (string)
         @param operation operation to be performed (Queues.QUEUE_DELETE,
             Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE)
+        @exception ValueError raised to indicate an invalid operation
         """
         # find the root of the repo
         repodir = self.vcs.splitPath(name)[0]
--- a/Plugins/VcsPlugins/vcsMercurial/__init__.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/__init__.py	Sun Sep 29 15:08:57 2013 +0200
@@ -4,7 +4,7 @@
 #
 
 """
-Package implementing the vcs interface to Mercurial
+Package implementing the vcs interface to Mercurial.
 
 It consists of the hg class, the project helper classes and some
 Mercurial specific dialogs.
--- a/Plugins/VcsPlugins/vcsMercurial/hg.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsMercurial/hg.py	Sun Sep 29 15:08:57 2013 +0200
@@ -1254,17 +1254,22 @@
         
         @param project reference to the project object
         @param archive name of the project in the repository (string)
-        @param editable flag indicating that the project name is editable (boolean)
+        @param editable flag indicating that the project name is editable
+            (boolean)
         @param parent parent widget (QWidget)
+        @return reference to the instantiated options dialog (HgOptionsDialog)
         """
         from .HgOptionsDialog import HgOptionsDialog
         return HgOptionsDialog(self, project, parent)
     
     def vcsNewProjectOptionsDialog(self, parent=None):
         """
-        Public method to get a dialog to enter repository info for getting a new project.
+        Public method to get a dialog to enter repository info for getting a
+        new project.
         
         @param parent parent widget (QWidget)
+        @return reference to the instantiated options dialog
+            (HgNewProjectOptionsDialog)
         """
         from .HgNewProjectOptionsDialog import HgNewProjectOptionsDialog
         return HgNewProjectOptionsDialog(self, parent)
@@ -1687,6 +1692,7 @@
         @param name file name to be diffed (string)
         @keyparam extended flag indicating the extended variant (boolean)
         @keyparam revisions tuple of two revisions (tuple of strings)
+        @exception ValueError raised to indicate an invalid name parameter
         """
         if isinstance(name, list):
             raise ValueError("Wrong parameter type")
@@ -1985,7 +1991,7 @@
         while not os.path.isdir(os.path.join(repodir, self.adminDir)):
             repodir = os.path.dirname(repodir)
             if os.path.splitdrive(repodir)[1] == os.sep:
-                return False
+                return
         
         dia = HgDialog(self.trUtf8('Resolving files/directories'), self)
         res = dia.startProcess(args, repodir)
@@ -2460,6 +2466,7 @@
         @param name file/directory name (string)
         @param subcommand name of the subcommand (string, one of 'good', 'bad',
             'skip' or 'reset')
+        @exception ValueError raised to indicate an invalid bisect subcommand
         """
         if subcommand not in ("good", "bad", "skip", "reset"):
             raise ValueError(
@@ -2741,6 +2748,7 @@
         @param data tuple giving phase data (list of revisions, phase, flag
             indicating a forced operation) (list of strings, string, boolean)
         @return flag indicating success (boolean)
+        @exception ValueError raised to indicate an invalid phase
         """
         dname, fname = self.splitPath(name)
         
@@ -3189,8 +3197,8 @@
         """
         Protected method to create an instance of the VCS status monitor thread.
         
+        @param interval check interval for the monitor thread in seconds (integer)
         @param project reference to the project object (Project)
-        @param interval check interval for the monitor thread in seconds (integer)
         @return reference to the monitor thread (QThread)
         """
         from .HgStatusMonitorThread import HgStatusMonitorThread
--- a/Plugins/VcsPlugins/vcsPySvn/Config.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/Config.py	Sun Sep 29 15:08:57 2013 +0200
@@ -4,7 +4,7 @@
 #
 
 """
-Module defining configuration variables for the subversion package
+Module defining configuration variables for the subversion package.
 """
 
 # Available protocols for the repository URL
--- a/Plugins/VcsPlugins/vcsPySvn/SvnDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/SvnDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -67,7 +67,7 @@
         
     def _clientNotifyCallback(self, eventDict):
         """
-        Protected method called by the client to send events
+        Protected method called by the client to send events.
         
         @param eventDict dictionary containing the notification event
         """
--- a/Plugins/VcsPlugins/vcsPySvn/SvnLogBrowserDialog.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/SvnLogBrowserDialog.py	Sun Sep 29 15:08:57 2013 +0200
@@ -511,7 +511,9 @@
     @pyqtSlot(bool)
     def on_stopCheckBox_clicked(self, checked):
         """
-        Private slot called, when the stop on copy/move checkbox is clicked
+        Private slot called, when the stop on copy/move checkbox is clicked.
+        
+        @param checked flag indicating the check box state (boolean)
         """
         self.vcs.getPlugin().setPreferences("StopLogOnCopy",
                                             int(self.stopCheckBox.isChecked()))
--- a/Plugins/VcsPlugins/vcsPySvn/__init__.py	Sun Sep 29 14:22:08 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/__init__.py	Sun Sep 29 15:08:57 2013 +0200
@@ -4,7 +4,7 @@
 #
 
 """
-Package implementing the vcs interface to Subversion
+Package implementing the vcs interface to Subversion.
 
 It consists of the subversion class, the project helper classes and some
 Subversion specific dialogs. This package is based upon the pysvn interface.
--- a/eric5.e4p	Sun Sep 29 14:22:08 2013 +0200
+++ b/eric5.e4p	Sun Sep 29 15:08:57 2013 +0200
@@ -1902,7 +1902,7 @@
               <string>ExcludeFiles</string>
             </key>
             <value>
-              <string>*/ThirdParty/*, */coverage/*, */Ui_*.py, */Examples/*, */*_rc.py</string>
+              <string>*/ThirdParty/*, */coverage/*, */Ui_*.py, */Examples/*, */*_rc.py,*/pep8.py</string>
             </value>
             <key>
               <string>ExcludeMessages</string>

eric ide

mercurial