Corrected some source code documentation.

Thu, 29 Aug 2024 13:16:22 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 29 Aug 2024 13:16:22 +0200
changeset 63
4b38c24b15dd
parent 62
99f2b6faeb86
child 64
ca47f1f288ea

Corrected some source code documentation.

PipxInterface/ConfigurationPage/PipxPage.py file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.PipxPage.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PluginPipxInterface.html file | annotate | diff | comparison | revisions
PluginPipxInterface.py file | annotate | diff | comparison | revisions
--- a/PipxInterface/ConfigurationPage/PipxPage.py	Wed Aug 28 15:27:02 2024 +0200
+++ b/PipxInterface/ConfigurationPage/PipxPage.py	Thu Aug 29 13:16:22 2024 +0200
@@ -49,7 +49,7 @@
 
     def save(self):
         """
-        Public slot to save the MQTT Monitor configuration.
+        Public slot to save the pipx interface configuration.
         """
         self.__plugin.setPreferences(
             "AutoCheckOutdated", self.autoCheckOutdatedCheckBox.isChecked()
--- a/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.PipxPage.html	Wed Aug 28 15:27:02 2024 +0200
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.PipxPage.html	Thu Aug 29 13:16:22 2024 +0200
@@ -57,7 +57,7 @@
 </tr>
 <tr>
 <td><a href="#PipxPage.save">save</a></td>
-<td>Public slot to save the MQTT Monitor configuration.</td>
+<td>Public slot to save the pipx interface configuration.</td>
 </tr>
 </table>
 
@@ -85,7 +85,7 @@
 <h4>PipxPage.save</h4>
 <b>save</b>(<i></i>)
 <p>
-        Public slot to save the MQTT Monitor configuration.
+        Public slot to save the pipx interface configuration.
 </p>
 
 <div align="right"><a href="#top">Up</a></div>
--- a/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PluginPipxInterface.html	Wed Aug 28 15:27:02 2024 +0200
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PluginPipxInterface.html	Thu Aug 29 13:16:22 2024 +0200
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#createPipxPage">createPipxPage</a></td>
-<td>Module function to create the autocompletion configuration page.</td>
+<td>Module function to create the pipx configuration page.</td>
 </tr>
 <tr>
 <td><a href="#exeDisplayData">exeDisplayData</a></td>
@@ -283,9 +283,9 @@
 <hr />
 <a NAME="createPipxPage" ID="createPipxPage"></a>
 <h2>createPipxPage</h2>
-<b>createPipxPage</b>(<i>_configDlg, </i>)
+<b>createPipxPage</b>(<i>_configDlg</i>)
 <p>
-    Module function to create the autocompletion configuration page.
+    Module function to create the pipx configuration page.
 </p>
 
 <dl>
@@ -304,7 +304,7 @@
 <dl>
 <dt>Return Type:</dt>
 <dd>
-AutoCompletionRopePage
+PipxPage
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/PluginPipxInterface.py	Wed Aug 28 15:27:02 2024 +0200
+++ b/PluginPipxInterface.py	Thu Aug 29 13:16:22 2024 +0200
@@ -85,16 +85,14 @@
     return data
 
 
-def createPipxPage(
-    _configDlg,
-):
+def createPipxPage(_configDlg):
     """
-    Module function to create the autocompletion configuration page.
+    Module function to create the pipx configuration page.
 
     @param _configDlg reference to the configuration dialog (unused)
     @type ConfigurationWidget
     @return reference to the configuration page
-    @rtype AutoCompletionRopePage
+    @rtype PipxPage
     """
     from PipxInterface.ConfigurationPage.PipxPage import PipxPage  # noqa: I102
 

eric ide

mercurial