Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipDialog.html	Tue Jun 12 19:01:06 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipDialog.html	Tue Jun 12 19:02:21 2018 +0200
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#PipDialog">PipDialog</a></td>
-<td>Class implementing a dialog showing the output of a pip command.</td>
+<td>Class implementing a dialog showing the output of a 'python -m pip' command.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -42,7 +42,8 @@
 <a NAME="PipDialog" ID="PipDialog"></a>
 <h2>PipDialog</h2>
 <p>
-    Class implementing a dialog showing the output of a pip command.
+    Class implementing a dialog showing the output of a 'python -m pip'
+    command.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_PipDialog
@@ -98,12 +99,12 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to be shown by the label (string)
-</dd><dt><i>parent</i></dt>
+text to be shown by the label
+</dd><dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl><a NAME="PipDialog.__addOutput" ID="PipDialog.__addOutput"></a>
 <h4>PipDialog.__addOutput</h4>
@@ -127,12 +128,12 @@
 <p>
         Private slot connected to the finished signal.
 </p><dl>
-<dt><i>exitCode</i></dt>
+<dt><i>exitCode</i> (int)</dt>
 <dd>
-exit code of the process (integer)
-</dd><dt><i>exitStatus</i></dt>
+exit code of the process
+</dd><dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
 <dd>
-exit status of the process (QProcess.ExitStatus)
+exit status of the process
 </dd>
 </dl><a NAME="PipDialog.__readStderr" ID="PipDialog.__readStderr"></a>
 <h4>PipDialog.__readStderr</h4>
@@ -156,9 +157,9 @@
 <p>
         Protected slot implementing a close event handler.
 </p><dl>
-<dt><i>e</i></dt>
+<dt><i>e</i> (QCloseEvent)</dt>
 <dd>
-close event (QCloseEvent)
+close event
 </dd>
 </dl><a NAME="PipDialog.on_buttonBox_clicked" ID="PipDialog.on_buttonBox_clicked"></a>
 <h4>PipDialog.on_buttonBox_clicked</h4>
@@ -166,9 +167,9 @@
 <p>
         Private slot called by a button of the button box clicked.
 </p><dl>
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
 <dd>
-button that was clicked (QAbstractButton)
+button that was clicked
 </dd>
 </dl><a NAME="PipDialog.startProcess" ID="PipDialog.startProcess"></a>
 <h4>PipDialog.startProcess</h4>
@@ -176,28 +177,33 @@
 <p>
         Public slot used to start the process.
 </p><dl>
-<dt><i>cmd</i></dt>
+<dt><i>cmd</i> (str)</dt>
 <dd>
-name of the pip executable to be used (string)
-</dd><dt><i>args</i></dt>
+name of the pip executable to be used
+</dd><dt><i>args</i> (list of str)</dt>
 <dd>
-list of arguments for the process (list of strings)
-</dd><dt><i>showArgs=</i></dt>
+list of arguments for the process
+</dd><dt><i>showArgs=</i> (bool)</dt>
 <dd>
-flag indicating to show the arguments (boolean)
+flag indicating to show the arguments
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a successful start of the process
 </dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="PipDialog.startProcesses" ID="PipDialog.startProcesses"></a>
 <h4>PipDialog.startProcesses</h4>
 <b>startProcesses</b>(<i>processParams</i>)
 <p>
         Public method to issue a list of commands to be executed.
 </p><dl>
-<dt><i>processParams</i> (list of tuples of str and list of str)</dt>
+<dt><i>processParams</i> (list of tuples of (str, list of str))</dt>
 <dd>
 list of tuples containing the command
             and arguments