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

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgClient.html	Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgClient.html	Mon Feb 01 10:38:16 2021 +0100
@@ -105,6 +105,10 @@
 <td></td>
 </tr>
 <tr>
+<td><a href="#HgClient.getRepository">getRepository</a></td>
+<td>Public method to get the repository path this client is serving.</td>
+</tr>
+<tr>
 <td><a href="#HgClient.isExecuting">isExecuting</a></td>
 <td>Public method to check, if the server is executing a command.</td>
 </tr>
@@ -184,7 +188,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple containing data entered by the user and
             a flag indicating a password input
@@ -204,7 +208,7 @@
         Private method to read data from the command server.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of channel designator and channel data
 </dd>
@@ -223,7 +227,7 @@
         Private method to read the hello message sent by the command server.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of flag indicating success and an error message in case
             of failure
@@ -262,7 +266,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 result code of the command, -1 if the command server wasn't
             started or -10, if the command was canceled
@@ -325,6 +329,25 @@
 <h4>HgClient.func</h4>
 <b>func</b>(<i></i>)
 
+<a NAME="HgClient.getRepository" ID="HgClient.getRepository"></a>
+<h4>HgClient.getRepository</h4>
+<b>getRepository</b>(<i></i>)
+
+<p>
+        Public method to get the repository path this client is serving.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+repository path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="HgClient.isExecuting" ID="HgClient.isExecuting"></a>
 <h4>HgClient.isExecuting</h4>
 <b>isExecuting</b>(<i></i>)
@@ -333,7 +356,7 @@
         Public method to check, if the server is executing a command.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the execution of a command
 </dd>
@@ -356,7 +379,7 @@
         Public method to restart the command server.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of flag indicating a successful start and an error
             message in case of failure
@@ -407,7 +430,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of output and errors of the command server. In case
             output and/or error functions were given, the respective return
@@ -428,7 +451,7 @@
         Public method to start the command server.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of flag indicating a successful start and an error
             message in case of failure
@@ -455,7 +478,7 @@
         Public method to check, if the last command was canceled.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating the cancel state
 </dd>

eric ide

mercurial