Updated source documentation. eric7

Mon, 02 Jan 2023 15:56:41 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 02 Jan 2023 15:56:41 +0100
branch
eric7
changeset 9661
1ef89052d991
parent 9660
1000e5fbc29c
child 9662
f968dcae55cf

Updated source documentation.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.PipInterface.PipPackageDetailsDialog.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Mon Jan 02 15:55:47 2023 +0100
+++ b/src/eric7/APIs/Python3/eric7.api	Mon Jan 02 15:56:41 2023 +0100
@@ -3188,7 +3188,7 @@
 eric7.PipInterface.PipPackageDetailsDialog.PipPackageDetailsDialog.ButtonRemove?7
 eric7.PipInterface.PipPackageDetailsDialog.PipPackageDetailsDialog.ButtonUpgrade?7
 eric7.PipInterface.PipPackageDetailsDialog.PipPackageDetailsDialog.on_buttonBox_clicked?4(button)
-eric7.PipInterface.PipPackageDetailsDialog.PipPackageDetailsDialog?1(detailsData, buttonsMode=0, parent=None)
+eric7.PipInterface.PipPackageDetailsDialog.PipPackageDetailsDialog?1(detailsData, vulnerabilities=None, buttonsMode=0, parent=None)
 eric7.PipInterface.PipPackagesInputDialog.PipPackagesInputDialog.getData?4()
 eric7.PipInterface.PipPackagesInputDialog.PipPackagesInputDialog.on_packagesEdit_textChanged?4(txt)
 eric7.PipInterface.PipPackagesInputDialog.PipPackagesInputDialog?1(pip, title, install=True, parent=None)
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Mon Jan 02 15:55:47 2023 +0100
+++ b/src/eric7/Documentation/Help/source.qhp	Mon Jan 02 15:56:41 2023 +0100
@@ -11618,6 +11618,7 @@
       <keyword name="PipPackageDetailsDialog.__populateDetails" id="PipPackageDetailsDialog.__populateDetails" ref="eric7.PipInterface.PipPackageDetailsDialog.html#PipPackageDetailsDialog.__populateDetails" />
       <keyword name="PipPackageDetailsDialog.__populateDownloadUrls" id="PipPackageDetailsDialog.__populateDownloadUrls" ref="eric7.PipInterface.PipPackageDetailsDialog.html#PipPackageDetailsDialog.__populateDownloadUrls" />
       <keyword name="PipPackageDetailsDialog.__populateRequiresProvides" id="PipPackageDetailsDialog.__populateRequiresProvides" ref="eric7.PipInterface.PipPackageDetailsDialog.html#PipPackageDetailsDialog.__populateRequiresProvides" />
+      <keyword name="PipPackageDetailsDialog.__populateVulnerabilities" id="PipPackageDetailsDialog.__populateVulnerabilities" ref="eric7.PipInterface.PipPackageDetailsDialog.html#PipPackageDetailsDialog.__populateVulnerabilities" />
       <keyword name="PipPackageDetailsDialog.__sanitize" id="PipPackageDetailsDialog.__sanitize" ref="eric7.PipInterface.PipPackageDetailsDialog.html#PipPackageDetailsDialog.__sanitize" />
       <keyword name="PipPackageDetailsDialog.on_buttonBox_clicked" id="PipPackageDetailsDialog.on_buttonBox_clicked" ref="eric7.PipInterface.PipPackageDetailsDialog.html#PipPackageDetailsDialog.on_buttonBox_clicked" />
       <keyword name="PipPackagesInputDialog" id="PipPackagesInputDialog" ref="eric7.PipInterface.PipPackagesInputDialog.html#PipPackagesInputDialog" />
--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipPackageDetailsDialog.html	Mon Jan 02 15:55:47 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipPackageDetailsDialog.html	Mon Jan 02 15:56:41 2023 +0100
@@ -79,6 +79,10 @@
 <td>Private method to populate the requires/provides tab.</td>
 </tr>
 <tr>
+<td><a href="#PipPackageDetailsDialog.__populateVulnerabilities">__populateVulnerabilities</a></td>
+<td>Private method to populate the Security tab.</td>
+</tr>
+<tr>
 <td><a href="#PipPackageDetailsDialog.__sanitize">__sanitize</a></td>
 <td>Private method to clean-up the given text.</td>
 </tr>
@@ -95,7 +99,7 @@
 
 <a NAME="PipPackageDetailsDialog.__init__" ID="PipPackageDetailsDialog.__init__"></a>
 <h4>PipPackageDetailsDialog (Constructor)</h4>
-<b>PipPackageDetailsDialog</b>(<i>detailsData, buttonsMode=0, parent=None</i>)
+<b>PipPackageDetailsDialog</b>(<i>detailsData, vulnerabilities=None, buttonsMode=0, parent=None</i>)
 
 <p>
         Constructor
@@ -106,6 +110,10 @@
 <dd>
 package details
 </dd>
+<dt><i>vulnerabilities</i> (list (optional))</dt>
+<dd>
+list of known vulnerabilities (defaults to None)
+</dd>
 <dt><i>buttonsMode</i> (int (optional))</dt>
 <dd>
 flags telling which convenience buttons to enable
@@ -210,6 +218,20 @@
 package details
 </dd>
 </dl>
+<a NAME="PipPackageDetailsDialog.__populateVulnerabilities" ID="PipPackageDetailsDialog.__populateVulnerabilities"></a>
+<h4>PipPackageDetailsDialog.__populateVulnerabilities</h4>
+<b>__populateVulnerabilities</b>(<i>vulnerabilities</i>)
+
+<p>
+        Private method to populate the Security tab.
+</p>
+<dl>
+
+<dt><i>vulnerabilities</i> (list)</dt>
+<dd>
+list of known vulnerabilities
+</dd>
+</dl>
 <a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a>
 <h4>PipPackageDetailsDialog.__sanitize</h4>
 <b>__sanitize</b>(<i>text, forUrl=False</i>)
--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Mon Jan 02 15:55:47 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Mon Jan 02 15:56:41 2023 +0100
@@ -797,7 +797,7 @@
 </p>
 <a NAME="PipPackagesWidget.__showPackageDetails" ID="PipPackagesWidget.__showPackageDetails"></a>
 <h4>PipPackagesWidget.__showPackageDetails</h4>
-<b>__showPackageDetails</b>(<i>packageName, packageVersion, upgradable=False, installable=False</i>)
+<b>__showPackageDetails</b>(<i>packageName, packageVersion, vulnerabilities=None, upgradable=False, installable=False</i>)
 
 <p>
         Private method to populate the package details dialog.
@@ -812,6 +812,10 @@
 <dd>
 version of the package
 </dd>
+<dt><i>vulnerabilities</i> (list (optional))</dt>
+<dd>
+list of known vulnerabilities (defaults to None)
+</dd>
 <dt><i>upgradable</i> (bool (optional))</dt>
 <dd>
 flag indicating that the package may be upgraded

eric ide

mercurial