diff -r c79ecba9cde7 -r 86cea8abd0f7 Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html Tue Jun 12 19:01:06 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html Tue Jun 12 19:02:21 2018 +0200
@@ -118,19 +118,19 @@
</table>
<a NAME="PipSearchDialog.__init__" ID="PipSearchDialog.__init__"></a>
<h4>PipSearchDialog (Constructor)</h4>
-<b>PipSearchDialog</b>(<i>pip, plugin, parent=None</i>)
+<b>PipSearchDialog</b>(<i>pip, indexUrl, parent=None</i>)
<p>
Constructor
</p><dl>
-<dt><i>pip</i></dt>
+<dt><i>pip</i> (Pip)</dt>
<dd>
-reference to the master object (Pip)
-</dd><dt><i>plugin</i></dt>
+reference to the master object
+</dd><dt><i>indexUrl</i> (str)</dt>
<dd>
-reference to the plugin object (ToolPipPlugin)
-</dd><dt><i>parent</i></dt>
+URL of XML RPC interface to the pypi index
+</dd><dt><i>parent</i> (QWidget)</dt>
<dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
</dd>
</dl><a NAME="PipSearchDialog.__detailsError" ID="PipSearchDialog.__detailsError"></a>
<h4>PipSearchDialog.__detailsError</h4>
@@ -138,12 +138,12 @@
<p>
Private method handling a details error.
</p><dl>
-<dt><i>errorCode</i></dt>
+<dt><i>errorCode</i> (int)</dt>
<dd>
-code of the error (integer)
-</dd><dt><i>errorString</i></dt>
+code of the error
+</dd><dt><i>errorString</i> (str)</dt>
<dd>
-error message (string)
+error message
</dd>
</dl><a NAME="PipSearchDialog.__displayPackageDetails" ID="PipSearchDialog.__displayPackageDetails"></a>
<h4>PipSearchDialog.__displayPackageDetails</h4>
@@ -151,10 +151,9 @@
<p>
Private method to display the returned package details.
</p><dl>
-<dt><i>data</i></dt>
+<dt><i>data</i> (tuple)</dt>
<dd>
-result data (tuple) with downloads information in the first
- element
+result data with downloads information in the first element
</dd>
</dl><a NAME="PipSearchDialog.__finish" ID="PipSearchDialog.__finish"></a>
<h4>PipSearchDialog.__finish</h4>
@@ -192,9 +191,9 @@
<p>
Private method to process the search result data from PyPI.
</p><dl>
-<dt><i>data</i></dt>
+<dt><i>data</i> (tuple)</dt>
<dd>
-result data (tuple) with hits in the first element
+result data with hits in the first element
</dd>
</dl><a NAME="PipSearchDialog.__score" ID="PipSearchDialog.__score"></a>
<h4>PipSearchDialog.__score</h4>
@@ -230,12 +229,12 @@
<p>
Private method handling a search error.
</p><dl>
-<dt><i>errorCode</i></dt>
+<dt><i>errorCode</i> (int)</dt>
<dd>
-code of the error (integer)
-</dd><dt><i>errorString</i></dt>
+code of the error
+</dd><dt><i>errorString</i> (str)</dt>
<dd>
-error message (string)
+error message
</dd>
</dl><a NAME="PipSearchDialog.__showDetails" ID="PipSearchDialog.__showDetails"></a>
<h4>PipSearchDialog.__showDetails</h4>
@@ -249,14 +248,19 @@
Private method to convert the list returned from pypi into a
packages list.
</p><dl>
-<dt><i>hits</i></dt>
+<dt><i>hits</i> (list of dict)</dt>
<dd>
-list returned from pypi (list of dict)
+list returned from pypi
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-list of packages (list of dict)
+list of packages
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of dict
</dd>
</dl><a NAME="PipSearchDialog.closeEvent" ID="PipSearchDialog.closeEvent"></a>
<h4>PipSearchDialog.closeEvent</h4>
@@ -264,9 +268,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="PipSearchDialog.on_buttonBox_clicked" ID="PipSearchDialog.on_buttonBox_clicked"></a>
<h4>PipSearchDialog.on_buttonBox_clicked</h4>
@@ -274,9 +278,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="PipSearchDialog.on_resultList_itemActivated" ID="PipSearchDialog.on_resultList_itemActivated"></a>
<h4>PipSearchDialog.on_resultList_itemActivated</h4>
@@ -284,12 +288,12 @@
<p>
Private slot reacting on an item activation.
</p><dl>
-<dt><i>item</i></dt>
+<dt><i>item</i> (QTreeWidgetItem)</dt>
<dd>
-reference to the activated item (QTreeWidgetItem)
-</dd><dt><i>column</i></dt>
+reference to the activated item
+</dd><dt><i>column</i> (int)</dt>
<dd>
-activated column (integer)
+activated column
</dd>
</dl><a NAME="PipSearchDialog.on_resultList_itemSelectionChanged" ID="PipSearchDialog.on_resultList_itemSelectionChanged"></a>
<h4>PipSearchDialog.on_resultList_itemSelectionChanged</h4>
@@ -307,9 +311,9 @@
<p>
Private slot handling a change of the search term.
</p><dl>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
<dd>
-search term (string)
+search term
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
