diff -r c4c17121eff8 -r a21d673a8f99 eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.hg.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.hg.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.hg.html Sat Jan 16 16:51:23 2021 +0100 @@ -623,7 +623,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of bookmarks (list of string) </dd> @@ -640,7 +640,7 @@ working directory. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> most recent commit message </dd> @@ -671,7 +671,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> contents of the file (string) and an error message (string) </dd> @@ -695,7 +695,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread </dd> @@ -763,7 +763,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the monitor thread (QThread) </dd> @@ -777,7 +777,7 @@ merge. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating commit merge capability </dd> @@ -796,7 +796,7 @@ Public method to check, if pull is possible. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating pull capability (boolean) </dd> @@ -809,7 +809,7 @@ Public method to check, if push is possible. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating push capability (boolean) </dd> @@ -829,7 +829,7 @@ Public method to get a reference to the command server interface. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the client (HgClient) </dd> @@ -842,7 +842,7 @@ Public method to get the encoding to be used by Mercurial. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> encoding (string) </dd> @@ -862,7 +862,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the extension object (boolean) </dd> @@ -876,7 +876,7 @@ definitions of sub-repositories. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> full path of the .hgsub file (string) </dd> @@ -889,7 +889,7 @@ Public method to get a reference to the plugin object. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the plugin object (VcsMercurialPlugin) </dd> @@ -902,7 +902,7 @@ Public method to check, if the project might have sub-repositories. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the existence of sub-repositories (boolean) </dd> @@ -915,7 +915,7 @@ Public method to abort an uncommitted merge. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the abortion contained an add or delete (boolean) @@ -1140,7 +1140,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating successful operation (boolean) </dd> @@ -1164,7 +1164,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd> @@ -1264,7 +1264,7 @@ Public method to get the list of bookmarks. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of bookmarks (list of string) </dd> @@ -1277,7 +1277,7 @@ Public method to get the list of branches. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of branches (list of string) </dd> @@ -1290,7 +1290,7 @@ Public method to get the current branch of the working directory. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> name of the current branch </dd> @@ -1316,7 +1316,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of tags (list of string) or list of tuples of tag name and flag indicating a local tag (list of tuple of string @@ -1339,7 +1339,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread (boolean) </dd> @@ -1360,7 +1360,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread </dd> @@ -1386,7 +1386,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread </dd> @@ -1412,7 +1412,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread </dd> @@ -1438,7 +1438,7 @@ Public method to import a patch file. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the import contained an add, a delete or a change to the project file (boolean) @@ -1504,7 +1504,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> properly normalized url for mercurial (string) </dd> @@ -1533,7 +1533,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success (boolean) </dd> @@ -1568,7 +1568,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete @@ -1664,7 +1664,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete (boolean) @@ -1777,7 +1777,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete @@ -1811,7 +1811,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of command options (list of string) </dd> @@ -1831,7 +1831,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an active extension (boolean) </dd> @@ -1929,7 +1929,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error @@ -1959,7 +1959,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an execution without errors (boolean) </dd> @@ -2080,7 +2080,7 @@ Public method used to test for the presence of the hg executable. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the existence (boolean) and an error message (string) @@ -2105,7 +2105,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an execution without errors (boolean) </dd> @@ -2135,7 +2135,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the project browser helper object </dd> @@ -2155,7 +2155,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the project helper object </dd> @@ -2187,7 +2187,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple containing a flag indicating an execution without errors and a flag indicating the version controll status @@ -2223,7 +2223,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> always TRUE </dd> @@ -2310,7 +2310,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating successfull operation (boolean) </dd> @@ -2323,7 +2323,7 @@ Public method returning the name of the vcs. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> always 'Mercurial' (string) </dd> @@ -2344,7 +2344,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the instantiated options dialog (HgNewProjectOptionsDialog) @@ -2378,7 +2378,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the instantiated options dialog (HgOptionsDialog) </dd> @@ -2398,7 +2398,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> a combination of canBeCommited and canBeAdded </dd> @@ -2438,7 +2438,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating successfull operation (boolean) </dd> @@ -2458,7 +2458,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> string with ready formated info for display (string) </dd> @@ -2494,7 +2494,7 @@ Public method to signal the support of user settable command options. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the support of user settable command options (boolean) @@ -2516,7 +2516,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the switch contained an add or delete (boolean) @@ -2546,7 +2546,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a performed tag action (boolean) </dd> @@ -2575,7 +2575,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete (boolean)