Corrected some code style and formatting issues and regenerated the source documentation accordingly. eric7

Sat, 04 Mar 2023 16:37:02 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 04 Mar 2023 16:37:02 +0100
branch
eric7
changeset 9847
d8c7ded575cb
parent 9846
f5a17960408a
child 9848
3d750b2e012c

Corrected some code style and formatting issues and regenerated the source documentation accordingly.

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.MicroPython.Devices.DeviceBase.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWidget.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/index-eric7.UI.html file | annotate | diff | comparison | revisions
src/eric7/MicroPython/Devices/DeviceBase.py file | annotate | diff | comparison | revisions
src/eric7/MicroPython/MicroPythonWidget.py file | annotate | diff | comparison | revisions
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Sat Mar 04 16:32:32 2023 +0100
+++ b/src/eric7/Documentation/Help/source.qhp	Sat Mar 04 16:37:02 2023 +0100
@@ -1186,7 +1186,6 @@
             <section title="eric7.UI.LogView" ref="eric7.UI.LogView.html" />
             <section title="eric7.UI.NotificationWidget" ref="eric7.UI.NotificationWidget.html" />
             <section title="eric7.UI.NumbersWidget" ref="eric7.UI.NumbersWidget.html" />
-            <section title="eric7.UI.PixmapCache" ref="eric7.UI.PixmapCache.html" />
             <section title="eric7.UI.Previewer" ref="eric7.UI.Previewer.html" />
             <section title="eric7.UI.PythonAstViewer" ref="eric7.UI.PythonAstViewer.html" />
             <section title="eric7.UI.PythonDisViewer" ref="eric7.UI.PythonDisViewer.html" />
@@ -12096,7 +12095,6 @@
       <keyword name="PipVulnerabilityChecker.__writeDataToCache" id="PipVulnerabilityChecker.__writeDataToCache" ref="eric7.PipInterface.PipVulnerabilityChecker.html#PipVulnerabilityChecker.__writeDataToCache" />
       <keyword name="PipVulnerabilityChecker.check" id="PipVulnerabilityChecker.check" ref="eric7.PipInterface.PipVulnerabilityChecker.html#PipVulnerabilityChecker.check" />
       <keyword name="PipVulnerabilityChecker.updateVulnerabilityDb" id="PipVulnerabilityChecker.updateVulnerabilityDb" ref="eric7.PipInterface.PipVulnerabilityChecker.html#PipVulnerabilityChecker.updateVulnerabilityDb" />
-      <keyword name="PixmapCache (Module)" id="PixmapCache (Module)" ref="eric7.UI.PixmapCache.html" />
       <keyword name="PixmapDiagram" id="PixmapDiagram" ref="eric7.Graphics.PixmapDiagram.html#PixmapDiagram" />
       <keyword name="PixmapDiagram (Constructor)" id="PixmapDiagram (Constructor)" ref="eric7.Graphics.PixmapDiagram.html#PixmapDiagram.__init__" />
       <keyword name="PixmapDiagram (Module)" id="PixmapDiagram (Module)" ref="eric7.Graphics.PixmapDiagram.html" />
@@ -21042,7 +21040,6 @@
       <file>eric7.UI.LogView.html</file>
       <file>eric7.UI.NotificationWidget.html</file>
       <file>eric7.UI.NumbersWidget.html</file>
-      <file>eric7.UI.PixmapCache.html</file>
       <file>eric7.UI.Previewer.html</file>
       <file>eric7.UI.Previewers.MarkdownExtensions.html</file>
       <file>eric7.UI.Previewers.PreviewerHTML.html</file>
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Sat Mar 04 16:32:32 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Sat Mar 04 16:37:02 2023 +0100
@@ -286,7 +286,7 @@
 </tr>
 <tr>
 <td><a href="#BaseDevice.mipInstall">mipInstall</a></td>
-<td>Public method</td>
+<td>Public method to install packages using 'mip'.</td>
 </tr>
 <tr>
 <td><a href="#BaseDevice.mkdir">mkdir</a></td>
@@ -1372,7 +1372,7 @@
 <b>mipInstall</b>(<i>package, version, mpy</i>)
 
 <p>
-        Public method 
+        Public method to install packages using 'mip'.
 </p>
 <dl>
 
@@ -1891,6 +1891,13 @@
         Public method to install packages using 'upip'.
 </p>
 <dl>
+
+<dt><i>packages</i> (list of str)</dt>
+<dd>
+list of package names
+</dd>
+</dl>
+<dl>
 <dt>Return:</dt>
 <dd>
 tuple of (str, str)
--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWidget.html	Sat Mar 04 16:32:32 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWidget.html	Sat Mar 04 16:37:02 2023 +0100
@@ -489,6 +489,14 @@
 package management method to be used (one of 'upip' or 'mip')
 </dd>
 </dl>
+<dl>
+
+<dt>Raises <b>ValueError</b>:</dt>
+<dd>
+raised to indicate an unsupported package management
+            method
+</dd>
+</dl>
 <a NAME="MicroPythonWidget.__manageIgnored" ID="MicroPythonWidget.__manageIgnored"></a>
 <h4>MicroPythonWidget.__manageIgnored</h4>
 <b>__manageIgnored</b>(<i></i>)
--- a/src/eric7/Documentation/Source/index-eric7.UI.html	Sat Mar 04 16:32:32 2023 +0100
+++ b/src/eric7/Documentation/Source/index-eric7.UI.html	Sat Mar 04 16:37:02 2023 +0100
@@ -116,10 +116,6 @@
 <td>Module implementing a widget to show numbers in different formats.</td>
 </tr>
 <tr>
-<td><a href="eric7.UI.PixmapCache.html">PixmapCache</a></td>
-<td>Module implementing a compatibility interface of the EricPixmapCache functionality to satisfy old plug-ins.</td>
-</tr>
-<tr>
 <td><a href="eric7.UI.Previewer.html">Previewer</a></td>
 <td>Module implementing a previewer widget for HTML, Markdown and ReST files.</td>
 </tr>
--- a/src/eric7/MicroPython/Devices/DeviceBase.py	Sat Mar 04 16:32:32 2023 +0100
+++ b/src/eric7/MicroPython/Devices/DeviceBase.py	Sat Mar 04 16:37:02 2023 +0100
@@ -1219,6 +1219,8 @@
         """
         Public method to install packages using 'upip'.
 
+        @param packages list of package names
+        @type list of str
         @return tuple containing the command output and errors
         @return tuple of (str, str)
         """
@@ -1234,7 +1236,7 @@
 
     def mipInstall(self, package, version, mpy):
         """
-        Public method 
+        Public method to install packages using 'mip'.
 
         @param package package name
         @type str
--- a/src/eric7/MicroPython/MicroPythonWidget.py	Sat Mar 04 16:32:32 2023 +0100
+++ b/src/eric7/MicroPython/MicroPythonWidget.py	Sat Mar 04 16:37:02 2023 +0100
@@ -35,8 +35,8 @@
 from eric7.EricWidgets import EricFileDialog, EricMessageBox
 from eric7.EricWidgets.EricApplication import ericApp
 from eric7.EricWidgets.EricListSelectionDialog import EricListSelectionDialog
+from eric7.EricWidgets.EricPlainTextDialog import EricPlainTextDialog
 from eric7.EricWidgets.EricProcessDialog import EricProcessDialog
-from eric7.EricWidgets.EricPlainTextDialog import EricPlainTextDialog
 from eric7.EricWidgets.EricZoomWidget import EricZoomWidget
 from eric7.SystemUtilities import FileSystemUtilities, OSUtilities
 from eric7.UI.Info import BugAddress
@@ -2049,6 +2049,8 @@
 
         @param method package management method to be used (one of 'upip' or 'mip')
         @type str
+        @exception ValueError raised to indicate an unsupported package management
+            method
         """
         from .MipPackageDialog import MipPackageDialog
 

eric ide

mercurial