Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html

changeset 6343
86cea8abd0f7
parent 6253
a148632e9610
diff -r c79ecba9cde7 -r 86cea8abd0f7 Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html	Tue Jun 12 19:01:06 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html	Tue Jun 12 19:02:21 2018 +0200
@@ -89,15 +89,15 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>detailsData</i></dt>
+<dt><i>detailsData</i> (dict)</dt>
 <dd>
-package details (dict)
-</dd><dt><i>downloadsData</i></dt>
+package details
+</dd><dt><i>downloadsData</i> (dict)</dt>
 <dd>
-downloads information (dict)
-</dd><dt><i>parent</i></dt>
+downloads information
+</dd><dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl><a NAME="PipPackageDetailsDialog.__formatSize" ID="PipPackageDetailsDialog.__formatSize"></a>
 <h4>PipPackageDetailsDialog.__formatSize</h4>
@@ -105,14 +105,19 @@
 <p>
         Private slot to format the size.
 </p><dl>
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
-size to be formatted (integer)
+size to be formatted
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-formatted size (string)
+formatted size
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl><a NAME="PipPackageDetailsDialog.__formatUploadDate" ID="PipPackageDetailsDialog.__formatUploadDate"></a>
 <h4>PipPackageDetailsDialog.__formatUploadDate</h4>
@@ -140,9 +145,9 @@
 <p>
         Private method to populate the details tab.
 </p><dl>
-<dt><i>detailsData</i></dt>
+<dt><i>detailsData</i> (dict)</dt>
 <dd>
-package details (dict)
+package details
 </dd>
 </dl><a NAME="PipPackageDetailsDialog.__populateDownloadUrls" ID="PipPackageDetailsDialog.__populateDownloadUrls"></a>
 <h4>PipPackageDetailsDialog.__populateDownloadUrls</h4>
@@ -150,9 +155,9 @@
 <p>
         Private method to populate the download URLs tab.
 </p><dl>
-<dt><i>downloadsData</i></dt>
+<dt><i>downloadsData</i> (dict)</dt>
 <dd>
-downloads information (dict)
+downloads information
 </dd>
 </dl><a NAME="PipPackageDetailsDialog.__populateRequiresProvides" ID="PipPackageDetailsDialog.__populateRequiresProvides"></a>
 <h4>PipPackageDetailsDialog.__populateRequiresProvides</h4>
@@ -160,9 +165,9 @@
 <p>
         Private method to populate the requires/provides tab.
 </p><dl>
-<dt><i>detailsData</i></dt>
+<dt><i>detailsData</i> (dict)</dt>
 <dd>
-package details (dict)
+package details
 </dd>
 </dl><a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a>
 <h4>PipPackageDetailsDialog.__sanitize</h4>
@@ -170,17 +175,22 @@
 <p>
         Private method to clean-up the given text.
 </p><dl>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-raw text (string)
-</dd><dt><i>forUrl</i></dt>
+raw text
+</dd><dt><i>forUrl</i> (bool)</dt>
 <dd>
-flag indicating to sanitize an URL text (boolean)
+flag indicating to sanitize an URL text
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-processed text (string)
+processed text
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial