eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html

changeset 7370
5fb53279f2df
parent 7273
391d6b7b1eff
child 7989
a21d673a8f99
diff -r dbeeed55df08 -r 5fb53279f2df eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html	Wed Jan 08 19:13:57 2020 +0100
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html	Mon Jan 13 19:23:08 2020 +0100
@@ -128,6 +128,18 @@
 <p>
         Private method to initialize the Mercurial client.
 </p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing an OK flag and potentially an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
 <a NAME="HgStatusMonitorThread._getInfo" ID="HgStatusMonitorThread._getInfo"></a>
 <h4>HgStatusMonitorThread._getInfo</h4>
 <b>_getInfo</b>(<i></i>)
@@ -135,10 +147,6 @@
 <p>
         Protected method implementing the real info action.
 </p>
-<p>
-        This method should be overridden and create a short info message to be
-        shown in the main window status bar right next to the status indicator.
-</p>
 <dl>
 <dt>Returns:</dt>
 <dd>
@@ -159,10 +167,10 @@
         Protected method implementing the monitoring action.
 </p>
 <p>
-        This method populates the statusList member variable
-        with a list of strings giving the status in the first column and the
-        path relative to the project directory starting with the third column.
-        The allowed status flags are:
+        This method populates the statusList member variable with a list of
+        strings giving the status in the first column and the path relative
+        to the project directory starting with the third column. The allowed
+        status flags are:
         <ul>
             <li>"A" path was added but not yet comitted</li>
             <li>"M" path has local changes</li>
@@ -176,8 +184,14 @@
 <dl>
 <dt>Returns:</dt>
 <dd>
-tuple of flag indicating successful operation (boolean) and
-            a status message in case of non successful operation (string)
+tuple of flag indicating successful operation and a status
+            message in case of non successful operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="HgStatusMonitorThread._shutdown" ID="HgStatusMonitorThread._shutdown"></a>

eric ide

mercurial