--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.git.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.git.html Sat Jan 16 16:51:23 2021 +0100 @@ -609,7 +609,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> contents of the file (string) and an error message (string) </dd> @@ -629,7 +629,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of available stashes (list of string) </dd> @@ -649,7 +649,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of dictionaries with submodule name, path, URL and branch </dd> @@ -675,7 +675,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of selected submodule path and flag indicating a cancellation @@ -702,7 +702,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of selected submodule paths and flag indicating a cancellation @@ -742,7 +742,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the monitor thread (QThread) </dd> @@ -762,7 +762,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 (VcsGitPlugin) </dd> @@ -851,7 +851,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete (boolean) @@ -921,7 +921,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete (boolean) @@ -969,7 +969,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a performed branch action (boolean) and a flag indicating, that the branch operation contained an add @@ -1035,7 +1035,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete (boolean) @@ -1056,7 +1056,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the cancellation contained an add or delete (boolean) @@ -1126,7 +1126,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread (boolean) </dd> @@ -1147,7 +1147,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread (boolean) </dd> @@ -1168,7 +1168,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread (boolean) </dd> @@ -1188,7 +1188,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread (boolean) </dd> @@ -1226,7 +1226,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating successful operation (boolean) </dd> @@ -1264,7 +1264,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd> @@ -1376,7 +1376,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of supported archive formats (list of strings) </dd> @@ -1408,7 +1408,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of branches (list of string) </dd> @@ -1432,7 +1432,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of heads (list of strings) </dd> @@ -1452,7 +1452,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> name of the current branch (string) </dd> @@ -1476,7 +1476,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of remote repository branches (list of string) </dd> @@ -1500,7 +1500,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> URL of the remote repository </dd> @@ -1530,7 +1530,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of tuples of remote repo name and repo URL (list of tuple of two strings) @@ -1551,7 +1551,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of remote repos (list of string) </dd> @@ -1575,7 +1575,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 @@ -1639,7 +1639,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> properly normalized url for git (string) </dd> @@ -1677,7 +1677,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete (boolean) @@ -1762,7 +1762,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete (boolean) @@ -1910,7 +1910,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the restore contained an add or delete (boolean) @@ -1935,7 +1935,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the restore contained an add or delete (boolean) @@ -1970,7 +1970,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful deletion (boolean) </dd> @@ -1994,7 +1994,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful deletion (boolean) </dd> @@ -2018,7 +2018,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the restore contained an add or delete (boolean) @@ -2039,7 +2039,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the save contained an add or delete (boolean) @@ -2227,7 +2227,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete (boolean) @@ -2277,7 +2277,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of command options (list of string) </dd> @@ -2368,7 +2368,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 @@ -2398,7 +2398,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an execution without errors (boolean) </dd> @@ -2515,7 +2515,7 @@ Public method used to test for the presence of the git executable. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the existance (boolean) and an error message (string) @@ -2540,7 +2540,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an execution without errors (boolean) </dd> @@ -2570,7 +2570,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the project browser helper object </dd> @@ -2590,7 +2590,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the project helper object </dd> @@ -2622,7 +2622,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 @@ -2658,7 +2658,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> always TRUE </dd> @@ -2741,7 +2741,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating successful operation (boolean) </dd> @@ -2754,7 +2754,7 @@ Public method returning the name of the vcs. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> always 'Git' (string) </dd> @@ -2775,7 +2775,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the instantiated options dialog (GitNewProjectOptionsDialog) @@ -2809,7 +2809,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the instantiated options dialog (GitOptionsDialog) </dd> @@ -2829,7 +2829,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> a combination of canBeCommited and canBeAdded </dd> @@ -2868,7 +2868,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating successful operation (boolean) </dd> @@ -2888,7 +2888,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> string with ready formated info for display (string) </dd> @@ -2924,7 +2924,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) @@ -2946,7 +2946,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the switch contained an add or delete (boolean) @@ -2976,7 +2976,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a performed tag action (boolean) </dd> @@ -3006,7 +3006,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that the update contained an add or delete (boolean)