Mercurial Repositories > eric / file diff

diff -r a00e63f6d766 -r c79ecba9cde7 Plugins/UiExtensionPlugins/PipInterface/PipDialog.py
--- a/Plugins/UiExtensionPlugins/PipInterface/PipDialog.py	Tue Jun 12 18:59:45 2018 +0200
+++ b/Plugins/UiExtensionPlugins/PipInterface/PipDialog.py	Tue Jun 12 19:01:06 2018 +0200
@@ -26,14 +26,17 @@
 
 class PipDialog(QDialog, Ui_PipDialog):
     """
-    Class implementing a dialog showing the output of a pip command.
+    Class implementing a dialog showing the output of a 'python -m pip'
+    command.
     """
     def __init__(self, text, parent=None):
         """
         Constructor
         
-        @param text text to be shown by the label (string)
-        @param parent reference to the parent widget (QWidget)
+        @param text text to be shown by the label
+        @type str
+        @param parent reference to the parent widget
+        @type QWidget
         """
         super(PipDialog, self).__init__(parent)
         self.setupUi(self)
@@ -51,7 +54,8 @@
         """
         Protected slot implementing a close event handler.
         
-        @param e close event (QCloseEvent)
+        @param e close event
+        @type QCloseEvent
         """
         self.__processQueue = []
         
@@ -92,7 +96,8 @@
         """
         Private slot called by a button of the button box clicked.
         
-        @param button button that was clicked (QAbstractButton)
+        @param button button that was clicked
+        @type QAbstractButton
         """
         if button == self.buttonBox.button(QDialogButtonBox.Close):
             self.close()
@@ -101,8 +106,10 @@
         """
         Private slot connected to the finished signal.
         
-        @param exitCode exit code of the process (integer)
-        @param exitStatus exit status of the process (QProcess.ExitStatus)
+        @param exitCode exit code of the process
+        @type int
+        @param exitStatus exit status of the process
+        @type QProcess.ExitStatus
         """
         self.__finish()
     
@@ -110,10 +117,14 @@
         """
         Public slot used to start the process.
         
-        @param cmd name of the pip executable to be used (string)
-        @param args list of arguments for the process (list of strings)
-        @keyparam showArgs flag indicating to show the arguments (boolean)
+        @param cmd name of the pip executable to be used
+        @type str
+        @param args list of arguments for the process
+        @type list of str
+        @keyparam showArgs flag indicating to show the arguments
+        @type bool
         @return flag indicating a successful start of the process
+        @rtype bool
         """
         if len(self.errors.toPlainText()) == 0:
             self.errorGroup.hide()
@@ -144,7 +155,7 @@
         
         @param processParams list of tuples containing the command
             and arguments
-        @type list of tuples of str and list of str
+        @type list of tuples of (str, list of str)
         @return flag indicating a successful start of the first process
         @rtype bool
         """