Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.VCS.VersionControl.html

src/eric7/Documentation/Source/eric7.VCS.VersionControl.html

branch
eric7
changeset 10436
f6881d10e995
parent 10259
b51dfacef37f
child 10438
4cd7e5a8b3cf
--- a/src/eric7/Documentation/Source/eric7.VCS.VersionControl.html	Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.VCS.VersionControl.html	Fri Dec 22 17:24:07 2023 +0100
@@ -376,13 +376,13 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of this object (string)
+name of this object
 </dd>
 </dl>
 <a NAME="VersionControl.__statusMonitorAllData" ID="VersionControl.__statusMonitorAllData"></a>
@@ -471,12 +471,11 @@
 </p>
 <dl>
 
-<dt><i>interval</i></dt>
+<dt><i>interval</i> (int)</dt>
 <dd>
 check interval for the monitor thread in seconds
-            (integer)
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
@@ -484,7 +483,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the monitor thread (QThread)
+reference to the monitor thread
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QThread
 </dd>
 </dl>
 <a NAME="VersionControl._vcsAddProjectCommitMessage" ID="VersionControl._vcsAddProjectCommitMessage"></a>
@@ -562,13 +567,13 @@
 </p>
 <dl>
 
-<dt><i>args</i></dt>
+<dt><i>args</i> (list of str)</dt>
 <dd>
-current arguments list (list of strings)
+current arguments list
 </dd>
-<dt><i>argslist</i></dt>
+<dt><i>argslist</i> (list of str)</dt>
 <dd>
-list of arguments (list of strings)
+list of arguments
 </dd>
 </dl>
 <a NAME="VersionControl.checkVCSStatus" ID="VersionControl.checkVCSStatus"></a>
@@ -594,9 +599,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the entry to be cleared (string)
+name of the entry to be cleared
 </dd>
 </dl>
 <a NAME="VersionControl.getStatusMonitorAutoUpdate" ID="VersionControl.getStatusMonitorAutoUpdate"></a>
@@ -609,7 +614,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-status of the auto update function (boolean)
+status of the auto update function
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="VersionControl.getStatusMonitorInterval" ID="VersionControl.getStatusMonitorInterval"></a>
@@ -622,7 +633,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-interval in seconds (integer)
+interval in seconds
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="VersionControl.setStatusMonitorAutoUpdate" ID="VersionControl.setStatusMonitorAutoUpdate"></a>
@@ -634,9 +651,9 @@
 </p>
 <dl>
 
-<dt><i>auto</i></dt>
+<dt><i>auto</i> (bool)</dt>
 <dd>
-status of the auto update function (boolean)
+status of the auto update function
 </dd>
 </dl>
 <a NAME="VersionControl.setStatusMonitorInterval" ID="VersionControl.setStatusMonitorInterval"></a>
@@ -648,11 +665,11 @@
 </p>
 <dl>
 
-<dt><i>interval</i></dt>
+<dt><i>interval</i> (int)</dt>
 <dd>
-new interval in seconds (integer)
+new interval in seconds
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
@@ -666,15 +683,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-path name (string)
+path name
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-a tuple of 2 strings (dirname, filename).
+tuple containing the directory name and the file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
 </dd>
 </dl>
 <a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a>
@@ -687,15 +710,21 @@
 </p>
 <dl>
 
-<dt><i>names</i></dt>
+<dt><i>names</i> (list of str)</dt>
 <dd>
-list of paths (list of strings)
+list of paths
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-a tuple of string and list of strings (dirname, filenamelist)
+tuple containing the directory name and the file name list
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, list of str)
 </dd>
 </dl>
 <a NAME="VersionControl.startStatusMonitor" ID="VersionControl.startStatusMonitor"></a>
@@ -707,7 +736,7 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
@@ -715,7 +744,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the monitor thread (QThread)
+reference to the monitor thread
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QThread
 </dd>
 </dl>
 <a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a>
@@ -731,27 +766,33 @@
 </p>
 <dl>
 
-<dt><i>proc</i></dt>
+<dt><i>proc</i> (QProcess)</dt>
 <dd>
-process to start (QProcess)
+process to start
 </dd>
-<dt><i>program</i></dt>
+<dt><i>program</i> (str)</dt>
 <dd>
-path of the executable to start (string)
+path of the executable to start
 </dd>
-<dt><i>arguments</i></dt>
+<dt><i>arguments</i> (list of str)</dt>
 <dd>
-list of arguments for the process (list of strings)
+list of arguments for the process
 </dd>
-<dt><i>workingDir</i></dt>
+<dt><i>workingDir</i> (str)</dt>
 <dd>
-working directory for the process (string)
+working directory for the process
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating normal exit (boolean)
+flag indicating normal exit
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="VersionControl.stopStatusMonitor" ID="VersionControl.stopStatusMonitor"></a>
@@ -770,17 +811,17 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be added (string)
+file/directory name to be added
 </dd>
-<dt><i>isDir</i></dt>
+<dt><i>isDir</i> (bool)</dt>
 <dd>
-flag indicating name is a directory (boolean)
+flag indicating name is a directory
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
-flag indicating quiet operations (boolean)
+flag indicating quiet operations
 </dd>
 </dl>
 <dl>
@@ -800,13 +841,13 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be added (string)
+file/directory name to be added
 </dd>
-<dt><i>isDir</i></dt>
+<dt><i>isDir</i> (bool)</dt>
 <dd>
-flag indicating name is a directory (boolean)
+flag indicating name is a directory
 </dd>
 </dl>
 <dl>
@@ -848,9 +889,9 @@
 </p>
 <dl>
 
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-root directory of the tree to be added (string)
+root directory of the tree to be added
 </dd>
 </dl>
 <dl>
@@ -871,13 +912,13 @@
 </p>
 <dl>
 
-<dt><i>names</i></dt>
+<dt><i>names</i> (dict)</dt>
 <dd>
 dictionary with all filenames to be checked as keys
 </dd>
-<dt><i>dname</i></dt>
+<dt><i>dname</i> (str)</dt>
 <dd>
-directory to check in (string)
+directory to check in
 </dd>
 </dl>
 <dl>
@@ -888,6 +929,12 @@
 </dd>
 </dl>
 <dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<dl>
 
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
@@ -904,15 +951,15 @@
 </p>
 <dl>
 
-<dt><i>vcsDataDict</i></dt>
+<dt><i>vcsDataDict</i> (dict)</dt>
 <dd>
 dictionary of data required for the checkout
 </dd>
-<dt><i>projectDir</i></dt>
+<dt><i>projectDir</i> (str)</dt>
 <dd>
-project directory to create (string)
+project directory to create
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
 flag indicating quiet operations
 </dd>
@@ -920,7 +967,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating an execution without errors (boolean)
+flag indicating an execution without errors
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>
@@ -940,9 +993,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-directory name to be cleaned up (string)
+directory name to be cleaned up
 </dd>
 </dl>
 <dl>
@@ -977,9 +1030,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-directory name of the working directory (string)
+directory name of the working directory
 </dd>
 </dl>
 <dl>
@@ -1000,23 +1053,29 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be committed (string)
+file/directory name to be committed
 </dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-message for this operation (string)
+message for this operation
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
-flag indicating quiet operations (boolean)
+flag indicating quiet operations
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>
@@ -1094,9 +1153,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be diffed (string)
+file/directory name to be diffed
 </dd>
 </dl>
 <dl>
@@ -1117,8 +1176,14 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of flag indicating the existence and a string
-            giving an error message in case of failure
+tuple of flag indicating the existence and an error message
+            in case of failure
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
 </dd>
 </dl>
 <dl>
@@ -1138,19 +1203,25 @@
 </p>
 <dl>
 
-<dt><i>vcsDataDict</i></dt>
+<dt><i>vcsDataDict</i> (dict)</dt>
 <dd>
 dictionary of data required for the export
 </dd>
-<dt><i>projectDir</i></dt>
+<dt><i>projectDir</i> (str)</dt>
 <dd>
-project directory to create (string)
+project directory to create
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating an execution without errors (boolean)
+flag indicating an execution without errors
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>
@@ -1197,6 +1268,12 @@
             vcsSetOptions.
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <a NAME="VersionControl.vcsGetOtherData" ID="VersionControl.vcsGetOtherData"></a>
 <h4>VersionControl.vcsGetOtherData</h4>
 <b>vcsGetOtherData</b>(<i></i>)
@@ -1210,6 +1287,12 @@
 a dictionary of vcs specific data
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a>
 <h4>VersionControl.vcsGetProjectBrowserHelper</h4>
 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
@@ -1220,15 +1303,15 @@
 </p>
 <dl>
 
-<dt><i>browser</i></dt>
+<dt><i>browser</i> (ProjectBaseBrowser)</dt>
 <dd>
 reference to the project browser object
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
-<dt><i>isTranslationsBrowser</i></dt>
+<dt><i>isTranslationsBrowser</i> (bool)</dt>
 <dd>
 flag indicating, the helper is requested
             for the translations browser (this needs some special treatment)
@@ -1241,6 +1324,12 @@
 </dd>
 </dl>
 <dl>
+<dt>Return Type:</dt>
+<dd>
+VcsProjectBrowserHelper
+</dd>
+</dl>
+<dl>
 
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
@@ -1257,7 +1346,7 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
@@ -1269,6 +1358,12 @@
 </dd>
 </dl>
 <dl>
+<dt>Return Type:</dt>
+<dd>
+VcsProjectHelper
+</dd>
+</dl>
+<dl>
 
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
@@ -1291,7 +1386,7 @@
 </dd>
 <dt><i>projectDir</i> (str)</dt>
 <dd>
-project directory (string)
+project directory
 </dd>
 <dt><i>noDialog</i> (bool)</dt>
 <dd>
@@ -1332,19 +1427,25 @@
 </p>
 <dl>
 
-<dt><i>vcsDir</i></dt>
+<dt><i>vcsDir</i> (str)</dt>
 <dd>
-name of the VCS directory (string)
+name of the VCS directory
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
-flag indicating quiet operations (boolean)
+flag indicating quiet operations
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>
@@ -1368,9 +1469,9 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
-reference to the project (Project)
+reference to the project
 </dd>
 </dl>
 <a NAME="VersionControl.vcsLogBrowser" ID="VersionControl.vcsLogBrowser"></a>
@@ -1383,14 +1484,13 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to show the log for (string)
+file/directory name to show the log for
 </dd>
-<dt><i>isFile</i></dt>
+<dt><i>isFile</i> (bool)</dt>
 <dd>
 flag indicating log for a file is to be shown
-            (boolean)
 </dd>
 </dl>
 <dl>
@@ -1410,9 +1510,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be merged (string)
+file/directory name to be merged
 </dd>
 </dl>
 <dl>
@@ -1432,19 +1532,19 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be moved (string)
+file/directory name to be moved
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
-<dt><i>target</i></dt>
+<dt><i>target</i> (str)</dt>
 <dd>
-new name of the file/directory (string)
+new name of the file/directory
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
 flag indicating quiet operations
 </dd>
@@ -1452,7 +1552,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating successfull operation (boolean)
+flag indicating successfull operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>
@@ -1473,7 +1579,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the vcs (string)
+name of the vcs
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <dl>
@@ -1494,9 +1606,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl>
 <dl>
@@ -1516,22 +1628,21 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
-<dt><i>archive</i></dt>
+<dt><i>archive</i> (str)</dt>
 <dd>
-name of the project in the repository (string)
+name of the project in the repository
 </dd>
-<dt><i>editable</i></dt>
+<dt><i>editable</i> (bool)</dt>
 <dd>
 flag indicating that the project name is editable
-            (boolean)
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl>
 <dl>
@@ -1551,9 +1662,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-filename to check (string)
+filename to check
 </dd>
 </dl>
 <dl>
@@ -1564,6 +1675,12 @@
 </dd>
 </dl>
 <dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl>
+<dl>
 
 <dt>Raises <b>NotImplementedError</b>:</dt>
 <dd>
@@ -1580,15 +1697,15 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be removed (string)
+file/directory name to be removed
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (bool)</dt>
 <dd>
-flag indicating deletion of a project tree (boolean)
+flag indicating deletion of a project tree
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
 flag indicating quiet operations
 </dd>
@@ -1596,7 +1713,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>
@@ -1616,15 +1739,21 @@
 </p>
 <dl>
 
-<dt><i>ppath</i></dt>
+<dt><i>ppath</i> (str)</dt>
 <dd>
-local path to get the repository infos (string)
+local path to get the repository infos
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-string with ready formated info for display (string)
+string with ready formated info for display
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <dl>
@@ -1724,11 +1853,11 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
-the key of the data (string)
+the key of the data
 </dd>
-<dt><i>value</i></dt>
+<dt><i>value</i> (Any)</dt>
 <dd>
 the value of the data
 </dd>
@@ -1742,7 +1871,7 @@
 </p>
 <dl>
 
-<dt><i>dictionary</i></dt>
+<dt><i>dictionary</i> (dict)</dt>
 <dd>
 dictionary to pick entries from
 </dd>
@@ -1756,10 +1885,10 @@
 </p>
 <dl>
 
-<dt><i>options</i></dt>
+<dt><i>options</i> (dict)</dt>
 <dd>
 a dictionary of option strings with keys as
-                defined by the default options
+            defined by the default options
 </dd>
 </dl>
 <a NAME="VersionControl.vcsSetOtherData" ID="VersionControl.vcsSetOtherData"></a>
@@ -1771,7 +1900,7 @@
 </p>
 <dl>
 
-<dt><i>data</i></dt>
+<dt><i>data</i> (dict)</dt>
 <dd>
 a dictionary of vcs specific data
 </dd>
@@ -1800,9 +1929,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to show the status for (string)
+file/directory name to show the status for
 </dd>
 </dl>
 <dl>
@@ -1824,7 +1953,12 @@
 <dt>Return:</dt>
 <dd>
 flag indicating the support  of user settable command options
-            (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="VersionControl.vcsSwitch" ID="VersionControl.vcsSwitch"></a>
@@ -1836,16 +1970,22 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-directory name to be switched (string)
+directory name to be switched
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 flag indicating, that the switch contained an add
-            or delete (boolean)
+            or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>
@@ -1865,9 +2005,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be tagged (string)
+file/directory name to be tagged
 </dd>
 </dl>
 <dl>
@@ -1887,20 +2027,26 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be updated (string)
+file/directory name to be updated
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
-flag indicating quiet operations (boolean)
+flag indicating quiet operations
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 flag indicating, that the update contained an add
-            or delete (boolean)
+            or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>

Mercurial Repository: eric

eric ide

mercurial