Sat, 23 Dec 2023 15:40:23 +0100
Converted some source code documentation to the new style.
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitApplyBundleDataDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitApplyBundleDataDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,18 +78,17 @@ </p> <dl> -<dt><i>bundleHeads</i></dt> +<dt><i>bundleHeads</i> (list of str)</dt> <dd> list of heads contained in a bundle - (list of strings) </dd> -<dt><i>branches</i></dt> +<dt><i>branches</i> (list of str)</dt> <dd> -list of available branch names (list of strings) +list of available branch names </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitApplyBundleDataDialog.getData" ID="GitApplyBundleDataDialog.getData"></a> @@ -102,8 +101,13 @@ <dl> <dt>Return:</dt> <dd> -tuple with the bundle head (string) and the local branch - name (string) +tuple with the bundle head (string) and the local branch name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitArchiveDataDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitArchiveDataDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -115,21 +115,21 @@ </p> <dl> -<dt><i>tagsList</i></dt> +<dt><i>tagsList</i> (list of str)</dt> <dd> -list of tags (list of strings) +list of tags </dd> -<dt><i>branchesList</i></dt> +<dt><i>branchesList</i> (list of str)</dt> <dd> -list of branches (list of strings) +list of branches </dd> -<dt><i>formatsList</i></dt> +<dt><i>formatsList</i> (list of str)</dt> <dd> -list of archive formats (list of strings) +list of archive formats </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitArchiveDataDialog.__updateOK" ID="GitArchiveDataDialog.__updateOK"></a> @@ -149,8 +149,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of selected revision (string), archive format (string), - archive file (string) and prefix (string) +tuple of selected revision, archive format, archive file and prefix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, str, str) </dd> </dl> <a NAME="GitArchiveDataDialog.on_branchButton_toggled" ID="GitArchiveDataDialog.on_branchButton_toggled"></a> @@ -162,9 +167,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitArchiveDataDialog.on_branchCombo_editTextChanged" ID="GitArchiveDataDialog.on_branchCombo_editTextChanged"></a> @@ -176,9 +181,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="GitArchiveDataDialog.on_fileButton_clicked" ID="GitArchiveDataDialog.on_fileButton_clicked"></a> @@ -197,9 +202,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="GitArchiveDataDialog.on_revButton_toggled" ID="GitArchiveDataDialog.on_revButton_toggled"></a> @@ -211,9 +216,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitArchiveDataDialog.on_revEdit_textChanged" ID="GitArchiveDataDialog.on_revEdit_textChanged"></a> @@ -225,9 +230,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="GitArchiveDataDialog.on_tagButton_toggled" ID="GitArchiveDataDialog.on_tagButton_toggled"></a> @@ -239,9 +244,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitArchiveDataDialog.on_tagCombo_editTextChanged" ID="GitArchiveDataDialog.on_tagCombo_editTextChanged"></a> @@ -253,9 +258,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBisectLogBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBisectLogBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -154,13 +154,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitBisectLogBrowserDialog.__finish" ID="GitBisectLogBrowserDialog.__finish"></a> @@ -180,23 +180,29 @@ </p> <dl> -<dt><i>commitId</i></dt> +<dt><i>commitId</i> (str)</dt> <dd> -commit id info (string) +commit id info </dd> -<dt><i>operation</i></dt> +<dt><i>operation</i> (str)</dt> <dd> -bisect operation (string) +bisect operation </dd> -<dt><i>subject</i></dt> +<dt><i>subject</i> (str)</dt> <dd> -subject of the bisect log entry (string) +subject of the bisect log entry </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the generated item (QTreeWidgetItem) +reference to the generated item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem </dd> </dl> <a NAME="GitBisectLogBrowserDialog.__getLogEntries" ID="GitBisectLogBrowserDialog.__getLogEntries"></a> @@ -222,13 +228,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitBisectLogBrowserDialog.__processBuffer" ID="GitBisectLogBrowserDialog.__processBuffer"></a> @@ -282,9 +288,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="GitBisectLogBrowserDialog.closeEvent" ID="GitBisectLogBrowserDialog.closeEvent"></a> @@ -296,9 +302,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="GitBisectLogBrowserDialog.keyPressEvent" ID="GitBisectLogBrowserDialog.keyPressEvent"></a> @@ -310,9 +316,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="GitBisectLogBrowserDialog.on_buttonBox_clicked" ID="GitBisectLogBrowserDialog.on_buttonBox_clicked"></a> @@ -324,9 +330,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitBisectLogBrowserDialog.on_input_returnPressed" ID="GitBisectLogBrowserDialog.on_input_returnPressed"></a> @@ -345,9 +351,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="GitBisectLogBrowserDialog.on_refreshButton_clicked" ID="GitBisectLogBrowserDialog.on_refreshButton_clicked"></a> @@ -380,9 +386,9 @@ </p> <dl> -<dt><i>projectdir</i></dt> +<dt><i>projectdir</i> (str)</dt> <dd> -directory name of the project (string) +directory name of the project </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBisectStartDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBisectStartDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -86,9 +86,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitBisectStartDialog.__updateOK" ID="GitBisectStartDialog.__updateOK"></a> @@ -108,9 +108,14 @@ <dl> <dt>Return:</dt> <dd> -tuple containing a bad commit (string), a list of good - commits (list of strings) and a flag indicating to not - checkout the working tree (boolean) +tuple containing a bad commit, a list of good commits and + a flag indicating to not checkout the working tree +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, list of str, bool) </dd> </dl> <a NAME="GitBisectStartDialog.on_badEdit_textChanged" ID="GitBisectStartDialog.on_badEdit_textChanged"></a> @@ -122,9 +127,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -bad commit entered (string) +bad commit entered </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBlameDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBlameDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -126,13 +126,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitBlameDialog.__finish" ID="GitBlameDialog.__finish"></a> @@ -190,13 +190,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitBlameDialog.__readStderr" ID="GitBlameDialog.__readStderr"></a> @@ -237,9 +237,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="GitBlameDialog.keyPressEvent" ID="GitBlameDialog.keyPressEvent"></a> @@ -251,9 +251,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="GitBlameDialog.on_buttonBox_clicked" ID="GitBlameDialog.on_buttonBox_clicked"></a> @@ -265,9 +265,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitBlameDialog.on_input_returnPressed" ID="GitBlameDialog.on_input_returnPressed"></a> @@ -286,9 +286,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="GitBlameDialog.on_sendButton_clicked" ID="GitBlameDialog.on_sendButton_clicked"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBranchDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBranchDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -102,25 +102,25 @@ </p> <dl> -<dt><i>branchlist</i></dt> +<dt><i>branchlist</i> (list of str)</dt> <dd> -list of previously entered branches (list of strings) +list of previously entered branches </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision to set tag for (string) +revision to set tag for </dd> -<dt><i>branchName</i></dt> +<dt><i>branchName</i> (str)</dt> <dd> -name of the branch (string) +name of the branch </dd> -<dt><i>branchOp</i></dt> +<dt><i>branchOp</i> (int)</dt> <dd> -desired branch operation (integer) +desired branch operation </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitBranchDialog.__updateOK" ID="GitBranchDialog.__updateOK"></a> @@ -140,9 +140,15 @@ <dl> <dt>Return:</dt> <dd> -tuple of an int, four strings and a boolean - (branch operation, branch name, revision, new branch name, - remote branch name, enforce operation) +tuple containing the branch operation, branch name, revision, + new branch name, remote branch name and a flag indicating to enforce + the operation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, str, str, str, bool) </dd> </dl> <a NAME="GitBranchDialog.on_branchCombo_editTextChanged" ID="GitBranchDialog.on_branchCombo_editTextChanged"></a> @@ -154,9 +160,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -branch name entered in the combo (string) +branch name entered in the combo </dd> </dl> <a NAME="GitBranchDialog.on_createTrackingButton_toggled" ID="GitBranchDialog.on_createTrackingButton_toggled"></a> @@ -168,9 +174,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the selection (boolean) +state of the selection </dd> </dl> <a NAME="GitBranchDialog.on_newBranchNameEdit_textChanged" ID="GitBranchDialog.on_newBranchNameEdit_textChanged"></a> @@ -182,9 +188,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -new branch name entered (string) +new branch name entered </dd> </dl> <a NAME="GitBranchDialog.on_setTrackingButton_toggled" ID="GitBranchDialog.on_setTrackingButton_toggled"></a> @@ -196,9 +202,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the selection (boolean) +state of the selection </dd> </dl> <a NAME="GitBranchDialog.on_unsetTrackingButton_toggled" ID="GitBranchDialog.on_unsetTrackingButton_toggled"></a> @@ -210,9 +216,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the selection (boolean) +state of the selection </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBranchPushDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBranchPushDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -82,21 +82,21 @@ </p> <dl> -<dt><i>branches</i></dt> +<dt><i>branches</i> (list of str)</dt> <dd> -list of branch names (list of string) +list of branch names </dd> -<dt><i>remotes</i></dt> +<dt><i>remotes</i> (list of str)</dt> <dd> -list of remote names (list of string) +list of remote names </dd> -<dt><i>delete</i></dt> +<dt><i>delete</i> (bool)</dt> <dd> -flag indicating a delete branch action (boolean) +flag indicating a delete branch action </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitBranchPushDialog.getData" ID="GitBranchPushDialog.getData"></a> @@ -110,7 +110,13 @@ <dt>Return:</dt> <dd> tuple of selected branch name, remote name and a flag - indicating all branches (tuple of two strings and a boolean) + indicating all branches +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, bool) </dd> </dl> <a NAME="GitBranchPushDialog.on_branchComboBox_editTextChanged" ID="GitBranchPushDialog.on_branchComboBox_editTextChanged"></a> @@ -122,9 +128,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -branch name (string) +branch name </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBundleDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitBundleDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -106,17 +106,17 @@ </p> <dl> -<dt><i>tagsList</i></dt> +<dt><i>tagsList</i> (list of str)</dt> <dd> -list of tags (list of strings) +list of tags </dd> -<dt><i>branchesList</i></dt> +<dt><i>branchesList</i> (list of str)</dt> <dd> -list of branches (list of strings) +list of branches </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitBundleDialog.__updateOK" ID="GitBundleDialog.__updateOK"></a> @@ -136,7 +136,13 @@ <dl> <dt>Return:</dt> <dd> -list of revision expressions (list of strings) +list of revision expressions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="GitBundleDialog.on_branchButton_toggled" ID="GitBundleDialog.on_branchButton_toggled"></a> @@ -148,9 +154,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitBundleDialog.on_branchCombo_editTextChanged" ID="GitBundleDialog.on_branchCombo_editTextChanged"></a> @@ -162,9 +168,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="GitBundleDialog.on_revisionsButton_toggled" ID="GitBundleDialog.on_revisionsButton_toggled"></a> @@ -176,9 +182,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitBundleDialog.on_revisionsEdit_textChanged" ID="GitBundleDialog.on_revisionsEdit_textChanged"></a> @@ -190,9 +196,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the line edit (string) +text of the line edit </dd> </dl> <a NAME="GitBundleDialog.on_tagButton_toggled" ID="GitBundleDialog.on_tagButton_toggled"></a> @@ -204,9 +210,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitBundleDialog.on_tagCombo_editTextChanged" ID="GitBundleDialog.on_tagCombo_editTextChanged"></a> @@ -218,9 +224,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCherryPickDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCherryPickDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -82,14 +82,13 @@ </p> <dl> -<dt><i>commits</i></dt> +<dt><i>commits</i> (list of str)</dt> <dd> -list of commits to show in the commits pane (list of - strings) +list of commits to show in the commits pane </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitCherryPickDialog.getData" ID="GitCherryPickDialog.getData"></a> @@ -105,7 +104,13 @@ tuple with list of commits, a flag indicating to append cherry-pick info to the commit message, a flag indicating to append a signed-off-by line to the commit message and a flag indicating to - not commit the action (list of strings, boolean, boolean, boolean) + not commit the action +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, bool, bool, bool) </dd> </dl> <a NAME="GitCherryPickDialog.on_commitsEdit_textChanged" ID="GitCherryPickDialog.on_commitsEdit_textChanged"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCommandDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCommandDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -87,17 +87,17 @@ </p> <dl> -<dt><i>argvList</i></dt> +<dt><i>argvList</i> (list of str)</dt> <dd> -history list of commandline arguments (list of strings) +history list of commandline arguments </dd> -<dt><i>ppath</i></dt> +<dt><i>ppath</i> (str)</dt> <dd> -pathname of the project directory (string) +pathname of the project directory </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of this dialog (QWidget) +parent widget of this dialog </dd> </dl> <a NAME="GitCommandDialog.getData" ID="GitCommandDialog.getData"></a> @@ -110,7 +110,13 @@ <dl> <dt>Return:</dt> <dd> -commandline parameters (string) +commandline parameters +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitCommandDialog.on_commandCombo_editTextChanged" ID="GitCommandDialog.on_commandCombo_editTextChanged"></a> @@ -122,9 +128,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -ignored +text of the combobox </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCommitDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCommitDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -122,25 +122,25 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -initial message (string) +initial message </dd> -<dt><i>amend</i></dt> +<dt><i>amend</i> (bool)</dt> <dd> -flag indicating to amend the HEAD commit (boolean) +flag indicating to amend the HEAD commit </dd> -<dt><i>commitAll</i></dt> +<dt><i>commitAll</i> (bool)</dt> <dd> -flag indicating to commit all local changes (boolean) +flag indicating to commit all local changes </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitCommitDialog.amend" ID="GitCommitDialog.amend"></a> @@ -153,7 +153,13 @@ <dl> <dt>Return:</dt> <dd> -state of the amend flag (boolean) +state of the amend flag +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="GitCommitDialog.logMessage" ID="GitCommitDialog.logMessage"></a> @@ -166,7 +172,13 @@ <dl> <dt>Return:</dt> <dd> -the log message (string) +the log message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitCommitDialog.on_buttonBox_accepted" ID="GitCommitDialog.on_buttonBox_accepted"></a> @@ -185,9 +197,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitCommitDialog.on_buttonBox_rejected" ID="GitCommitDialog.on_buttonBox_rejected"></a> @@ -221,7 +233,13 @@ <dl> <dt>Return:</dt> <dd> -state of the reset author flag (boolean) +state of the reset author flag +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="GitCommitDialog.showEvent" ID="GitCommitDialog.showEvent"></a> @@ -233,9 +251,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QShowEvent)</dt> <dd> -the event (QShowEvent) +the event </dd> </dl> <a NAME="GitCommitDialog.stagedOnly" ID="GitCommitDialog.stagedOnly"></a> @@ -248,7 +266,13 @@ <dl> <dt>Return:</dt> <dd> -state of the staged only flag (boolean) +state of the staged only flag +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCopyDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitCopyDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -87,17 +87,17 @@ </p> <dl> -<dt><i>source</i></dt> +<dt><i>source</i> (str)</dt> <dd> -name of the source file/directory (string) +name of the source file/directory </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> -<dt><i>move</i></dt> +<dt><i>move</i> (bool)</dt> <dd> -flag indicating a move operation (boolean) +flag indicating a move operation </dd> </dl> <a NAME="GitCopyDialog.getData" ID="GitCopyDialog.getData"></a> @@ -110,8 +110,13 @@ <dl> <dt>Return:</dt> <dd> -the target name (string) and a flag indicating - the operation should be enforced (boolean) +the target name and a flag indicating the operation should be enforced +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) </dd> </dl> <a NAME="GitCopyDialog.on_dirButton_clicked" ID="GitCopyDialog.on_dirButton_clicked"></a> @@ -131,9 +136,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -contents of the target edit (string) +contents of the target edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDescribeDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDescribeDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -126,13 +126,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitDescribeDialog.__finish" ID="GitDescribeDialog.__finish"></a> @@ -152,13 +152,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitDescribeDialog.__readStderr" ID="GitDescribeDialog.__readStderr"></a> @@ -206,9 +206,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="GitDescribeDialog.keyPressEvent" ID="GitDescribeDialog.keyPressEvent"></a> @@ -220,9 +220,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="GitDescribeDialog.on_buttonBox_clicked" ID="GitDescribeDialog.on_buttonBox_clicked"></a> @@ -234,9 +234,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitDescribeDialog.on_input_returnPressed" ID="GitDescribeDialog.on_input_returnPressed"></a> @@ -255,9 +255,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="GitDescribeDialog.on_sendButton_clicked" ID="GitDescribeDialog.on_sendButton_clicked"></a> @@ -276,13 +276,13 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -name of directory to be listed (string) +name of directory to be listed </dd> -<dt><i>commits</i></dt> +<dt><i>commits</i> (list of str)</dt> <dd> -list of commits to be described (list of string) +list of commits to be described </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -139,17 +139,17 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text to be shown by the label (string) +text to be shown by the label </dd> -<dt><i>git</i></dt> +<dt><i>git</i> (Git)</dt> <dd> -reference to the Git interface object (Git) +reference to the Git interface object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitDialog.__finish" ID="GitDialog.__finish"></a> @@ -169,13 +169,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitDialog.__readStderr" ID="GitDialog.__readStderr"></a> @@ -209,9 +209,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="GitDialog.__showOutput" ID="GitDialog.__showOutput"></a> @@ -223,9 +223,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -output to be shown (string) +output to be shown </dd> </dl> <a NAME="GitDialog.hasAddOrDelete" ID="GitDialog.hasAddOrDelete"></a> @@ -238,7 +238,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of an add or delete (boolean) +flag indicating the presence of an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="GitDialog.keyPressEvent" ID="GitDialog.keyPressEvent"></a> @@ -250,9 +256,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="GitDialog.normalExit" ID="GitDialog.normalExit"></a> @@ -265,7 +271,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating normal process termination (boolean) +flag indicating normal process termination +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="GitDialog.normalExitWithoutErrors" ID="GitDialog.normalExitWithoutErrors"></a> @@ -279,7 +291,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating normal process termination (boolean) +flag indicating normal process termination +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="GitDialog.on_buttonBox_clicked" ID="GitDialog.on_buttonBox_clicked"></a> @@ -291,9 +309,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitDialog.on_input_returnPressed" ID="GitDialog.on_input_returnPressed"></a> @@ -312,9 +330,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="GitDialog.on_sendButton_clicked" ID="GitDialog.on_sendButton_clicked"></a> @@ -333,28 +351,34 @@ </p> <dl> -<dt><i>args</i></dt> +<dt><i>args</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> -<dt><i>showArgs</i></dt> +<dt><i>showArgs</i> (bool)</dt> <dd> -flag indicating to show the arguments (boolean) +flag indicating to show the arguments </dd> -<dt><i>environment</i></dt> +<dt><i>environment</i> (dict)</dt> <dd> dictionary of environment settings to add - or change for the git process (dict of string and string) + or change for the git process </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a successful start of the process (boolean) +flag indicating a successful start of the process +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -108,13 +108,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitDiffDialog.__generatorFinished" ID="GitDiffDialog.__generatorFinished"></a> @@ -133,7 +133,7 @@ </p> <dl> -<dt><i>fileSeparators</i></dt> +<dt><i>fileSeparators</i> (list of str)</dt> <dd> list of file separator entries to be merged </dd> @@ -144,6 +144,12 @@ merged list of file separator entries </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> <a NAME="GitDiffDialog.closeEvent" ID="GitDiffDialog.closeEvent"></a> <h4>GitDiffDialog.closeEvent</h4> <b>closeEvent</b>(<i>e</i>) @@ -153,9 +159,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="GitDiffDialog.on_buttonBox_clicked" ID="GitDiffDialog.on_buttonBox_clicked"></a> @@ -167,9 +173,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitDiffDialog.on_filesCombo_activated" ID="GitDiffDialog.on_filesCombo_activated"></a> @@ -181,9 +187,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -activated row (integer) +activated row </dd> </dl> <a NAME="GitDiffDialog.on_refreshButton_clicked" ID="GitDiffDialog.on_refreshButton_clicked"></a> @@ -213,16 +219,15 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to be diffed (string) +filename to be diffed </dd> -<dt><i>versions</i></dt> +<dt><i>versions</i> (list of up to 2 str or None)</dt> <dd> -list of versions to be diffed (list of up to 2 strings - or None) +list of versions to be diffed </dd> -<dt><i>diffMode</i></dt> +<dt><i>diffMode</i> (str)</dt> <dd> indication for the type of diff to be performed ( 'work2repo' compares the working tree with the HEAD commit, @@ -232,13 +237,13 @@ and the staging area with the HEAD commit, 'stash' shows the diff for a stash) </dd> -<dt><i>stashName</i></dt> +<dt><i>stashName</i> (str)</dt> <dd> -name of the stash to show a diff for (string) +name of the stash to show a diff for </dd> -<dt><i>refreshable</i></dt> +<dt><i>refreshable</i> (bool)</dt> <dd> -flag indicating a refreshable diff (boolean) +flag indicating a refreshable diff </dd> </dl> <dl>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffGenerator.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffGenerator.html Sat Dec 23 15:40:23 2023 +0100 @@ -115,13 +115,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitDiffGenerator.__procFinished" ID="GitDiffGenerator.__procFinished"></a> @@ -133,13 +133,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitDiffGenerator.__processFileLine" ID="GitDiffGenerator.__processFileLine"></a> @@ -151,14 +151,14 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -line to be processed (string) +line to be processed </dd> -<dt><i>isTopDiff</i></dt> +<dt><i>isTopDiff</i> (bool)</dt> <dd> flag indicating to show the output in the top - output widget (boolean) + output widget </dd> </dl> <a NAME="GitDiffGenerator.__processLine" ID="GitDiffGenerator.__processLine"></a> @@ -170,14 +170,14 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -output line to process (string) +output line to process </dd> -<dt><i>isTopDiff</i></dt> +<dt><i>isTopDiff</i> (bool)</dt> <dd> flag indicating to show the output in the top - output widget (boolean) + output widget </dd> </dl> <a NAME="GitDiffGenerator.__readStderr" ID="GitDiffGenerator.__readStderr"></a> @@ -232,6 +232,12 @@ and the line into the diff output. </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, list of str, list of str, list of (str, int)) +</dd> +</dl> <a NAME="GitDiffGenerator.start" ID="GitDiffGenerator.start"></a> <h4>GitDiffGenerator.start</h4> <b>start</b>(<i>fn, versions=None, diffMode="work2repo", stashName=""</i>) @@ -241,16 +247,15 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to be diffed (string) +filename to be diffed </dd> -<dt><i>versions</i></dt> +<dt><i>versions</i> (list of up to 2 str or None)</dt> <dd> -list of versions to be diffed (list of up to 2 strings - or None) +list of versions to be diffed </dd> -<dt><i>diffMode</i></dt> +<dt><i>diffMode</i> (str)</dt> <dd> indication for the type of diff to be performed ( 'work2repo' compares the working tree with the HEAD commit, @@ -260,15 +265,21 @@ and the staging area with the HEAD commit, 'stash' shows the diff for a stash) </dd> -<dt><i>stashName</i></dt> +<dt><i>stashName</i> (str)</dt> <dd> -name of the stash to show a diff for (string) +name of the stash to show a diff for </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating the start status (boolean) +flag indicating the start status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <dl>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffHighlighter.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffHighlighter.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,14 +78,14 @@ </p> <dl> -<dt><i>doc</i></dt> +<dt><i>doc</i> (QTextDocument)</dt> <dd> -reference to the text document (QTextDocument) +reference to the text document </dd> -<dt><i>whitespace</i></dt> +<dt><i>whitespace</i> (bool)</dt> <dd> flag indicating to highlight whitespace - at the end of a line (boolean) + at the end of a line </dd> </dl> <a NAME="GitDiffHighlighter.generateRules" ID="GitDiffHighlighter.generateRules"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffParser.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffParser.html Sat Dec 23 15:40:23 2023 +0100 @@ -106,9 +106,9 @@ </p> <dl> -<dt><i>diff</i></dt> +<dt><i>diff</i> (list of str)</dt> <dd> -output of the diff command (list of string) +output of the diff command </dd> </dl> <a NAME="GitDiffParser.__generateHunkHeader" ID="GitDiffParser.__generateHunkHeader"></a> @@ -120,31 +120,37 @@ </p> <dl> -<dt><i>oldStart</i></dt> +<dt><i>oldStart</i> (int)</dt> <dd> -start line of the old part (integer) +start line of the old part </dd> -<dt><i>oldCount</i></dt> +<dt><i>oldCount</i> (int)</dt> <dd> -line count of the old part (integer) +line count of the old part </dd> -<dt><i>newStart</i></dt> +<dt><i>newStart</i> (int)</dt> <dd> -start line of the new part (integer) +start line of the new part </dd> -<dt><i>newCount</i></dt> +<dt><i>newCount</i> (int)</dt> <dd> -line count of the new part (integer) +line count of the new part </dd> -<dt><i>heading</i></dt> +<dt><i>heading</i> (str)</dt> <dd> -hunk heading (string) +hunk heading </dd> </dl> <dl> <dt>Return:</dt> <dd> -hunk header (string) +hunk header +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitDiffParser.__generateRange" ID="GitDiffParser.__generateRange"></a> @@ -156,19 +162,25 @@ </p> <dl> -<dt><i>start</i></dt> +<dt><i>start</i> (int)</dt> <dd> -start line (integer) +start line </dd> -<dt><i>count</i></dt> +<dt><i>count</i> (int)</dt> <dd> -line count (integer) +line count </dd> </dl> <dl> <dt>Return:</dt> <dd> -hunk header range (string) +hunk header range +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitDiffParser.__initHunk" ID="GitDiffParser.__initHunk"></a> @@ -181,7 +193,13 @@ <dl> <dt>Return:</dt> <dd> -hunk data structure (dictionary) +hunk data structure +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <a NAME="GitDiffParser.__parseDiff" ID="GitDiffParser.__parseDiff"></a> @@ -208,15 +226,21 @@ </p> <dl> -<dt><i>headerRange</i></dt> +<dt><i>headerRange</i> (str)</dt> <dd> -hunk header range (string) +hunk header range </dd> </dl> <dl> <dt>Return:</dt> <dd> -tuple of hunk start and hunk length (integer, integer) +tuple of hunk start and hunk length +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int) </dd> </dl> <a NAME="GitDiffParser.createHunkPatch" ID="GitDiffParser.createHunkPatch"></a> @@ -228,15 +252,21 @@ </p> <dl> -<dt><i>lineIndex</i></dt> +<dt><i>lineIndex</i> (int)</dt> <dd> -line number of the hunk (integer) +line number of the hunk </dd> </dl> <dl> <dt>Return:</dt> <dd> -diff lines of the patch (string) +diff lines of the patch +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitDiffParser.createLinesPatch" ID="GitDiffParser.createLinesPatch"></a> @@ -248,23 +278,29 @@ </p> <dl> -<dt><i>startIndex</i></dt> +<dt><i>startIndex</i> (int)</dt> <dd> -start line number (integer) +start line number </dd> -<dt><i>endIndex</i></dt> +<dt><i>endIndex</i> (int)</dt> <dd> -end line number (integer) +end line number </dd> -<dt><i>reverse</i></dt> +<dt><i>reverse</i> (bool)</dt> <dd> -flag indicating a reverse patch (boolean) +flag indicating a reverse patch </dd> </dl> <dl> <dt>Return:</dt> <dd> -diff lines of the patch (string) +diff lines of the patch +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitDiffParser.headerLength" ID="GitDiffParser.headerLength"></a> @@ -277,7 +313,13 @@ <dl> <dt>Return:</dt> <dd> -length of the header (integer) +length of the header +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitFetchDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitFetchDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -102,17 +102,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the git object </dd> -<dt><i>repodir</i></dt> +<dt><i>repodir</i> (str)</dt> <dd> -directory name of the local repository (string) +directory name of the local repository </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitFetchDialog.__okButtonEnable" ID="GitFetchDialog.__okButtonEnable"></a> @@ -143,8 +143,12 @@ remote branches, local branch, a flag indicating to fetch from all repositories, a flag indicating to remove obsolete tracking references and a flag indicating to fetch tags as well - (string, string, list of strings, string, boolean, boolean, - boolean) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, list of str, str, bool, bool, bool) </dd> </dl> <a NAME="GitFetchDialog.on_remoteBranchesList_itemSelectionChanged" ID="GitFetchDialog.on_remoteBranchesList_itemSelectionChanged"></a> @@ -163,9 +167,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -current text of the URL edit (string) +current text of the URL edit </dd> </dl> <a NAME="GitFetchDialog.on_remotesComboBox_currentTextChanged" ID="GitFetchDialog.on_remotesComboBox_currentTextChanged"></a> @@ -177,9 +181,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -current text of the combo box (string) +current text of the combo box </dd> </dl> <a NAME="GitFetchDialog.on_updateButton_clicked" ID="GitFetchDialog.on_updateButton_clicked"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitListDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitListDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,13 +78,13 @@ </p> <dl> -<dt><i>selections</i></dt> +<dt><i>selections</i> (list of str)</dt> <dd> -list of entries to select from (list of string) +list of entries to select from </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitListDialog.getSelection" ID="GitListDialog.getSelection"></a> @@ -97,7 +97,13 @@ <dl> <dt>Return:</dt> <dd> -list of selected entries (list of string) +list of selected entries +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitLogBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitLogBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -398,13 +398,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitLogBrowserDialog.__actionMode" ID="GitLogBrowserDialog.__actionMode"></a> @@ -417,7 +417,13 @@ <dl> <dt>Return:</dt> <dd> -selected action mode (string, one of filter or find) +selected action mode (one of 'filter' or 'find') +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitLogBrowserDialog.__addFinishCallback" ID="GitLogBrowserDialog.__addFinishCallback"></a> @@ -498,13 +504,13 @@ </p> <dl> -<dt><i>backwards</i></dt> +<dt><i>backwards</i> (bool)</dt> <dd> -flag indicating to search backwards (boolean) +flag indicating to search backwards </dd> -<dt><i>interactive</i></dt> +<dt><i>interactive</i> (bool)</dt> <dd> -flag indicating an interactive search (boolean) +flag indicating an interactive search </dd> </dl> <a NAME="GitLogBrowserDialog.__finish" ID="GitLogBrowserDialog.__finish"></a> @@ -565,13 +571,13 @@ </p> <dl> -<dt><i>commitId</i></dt> +<dt><i>commitId</i> (str)</dt> <dd> -commit id to calculate edge info for (string) +commit id to calculate edge info for </dd> -<dt><i>parents</i></dt> +<dt><i>parents</i> (list of str)</dt> <dd> -list of parent commits (list of strings) +list of parent commits </dd> </dl> <dl> @@ -580,7 +586,12 @@ tuple containing the column and color index for the given node and a list of tuples indicating the edges between the given node and its parents - (integer, integer, [(integer, integer, integer), ...]) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int, [(int, int, int), ...]) </dd> </dl> <a NAME="GitLogBrowserDialog.__generateFileItem" ID="GitLogBrowserDialog.__generateFileItem"></a> @@ -592,32 +603,38 @@ </p> <dl> -<dt><i>action</i></dt> +<dt><i>action</i> (str)</dt> <dd> indicator for the change action ("A", "C", "D", "M", "R", "T", "U", "X") </dd> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -path of the file in the repository (string) +path of the file in the repository </dd> -<dt><i>copyfrom</i></dt> +<dt><i>copyfrom</i> (str)</dt> <dd> -path the file was copied from (string) +path the file was copied from </dd> -<dt><i>additions</i></dt> +<dt><i>additions</i> (int)</dt> <dd> -number of added lines (int) +number of added lines </dd> -<dt><i>deletions</i></dt> +<dt><i>deletions</i> (int)</dt> <dd> -number of deleted lines (int) +number of deleted lines </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the generated item (QTreeWidgetItem) +reference to the generated item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem </dd> </dl> <a NAME="GitLogBrowserDialog.__generateIcon" ID="GitLogBrowserDialog.__generateIcon"></a> @@ -630,34 +647,38 @@ </p> <dl> -<dt><i>column</i></dt> +<dt><i>column</i> (int)</dt> <dd> -column index of the revision (integer) +column index of the revision </dd> -<dt><i>bottomedges</i></dt> +<dt><i>bottomedges</i> (list of [(int, int, int)])</dt> <dd> list of edges for the bottom of the node - (list of tuples of three integers) </dd> -<dt><i>topedges</i></dt> +<dt><i>topedges</i> (list of [(int, int, int)])</dt> <dd> list of edges for the top of the node - (list of tuples of three integers) </dd> -<dt><i>dotColor</i></dt> +<dt><i>dotColor</i> (QColor)</dt> <dd> -color to be used for the dot (QColor) +color to be used for the dot </dd> -<dt><i>currentCommit</i></dt> +<dt><i>currentCommit</i> (bool)</dt> <dd> flag indicating to draw the icon for the - current commit (boolean) + current commit </dd> </dl> <dl> <dt>Return:</dt> <dd> -icon for the node (QIcon) +icon for the node +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QIcon </dd> </dl> <a NAME="GitLogBrowserDialog.__generateLogItem" ID="GitLogBrowserDialog.__generateLogItem"></a> @@ -669,64 +690,70 @@ </p> <dl> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author info (string) +author info </dd> -<dt><i>date</i></dt> +<dt><i>date</i> (str)</dt> <dd> -date info (string) +date info </dd> -<dt><i>committer</i></dt> +<dt><i>committer</i> (str)</dt> <dd> -committer info (string) +committer info </dd> -<dt><i>commitDate</i></dt> +<dt><i>commitDate</i> (str)</dt> <dd> -commit date info (string) +commit date info </dd> -<dt><i>subject</i></dt> +<dt><i>subject</i> (str)</dt> <dd> -subject of the log entry (string) +subject of the log entry </dd> -<dt><i>message</i></dt> +<dt><i>message</i> (list of str)</dt> <dd> -text of the log message (list of strings) +text of the log message </dd> -<dt><i>commitId</i></dt> +<dt><i>commitId</i> (str)</dt> <dd> -commit id info (string) +commit id info </dd> -<dt><i>fullCommitId</i></dt> +<dt><i>fullCommitId</i> (str)</dt> <dd> -unabbreviated commit id info (string) +unabbreviated commit id info </dd> -<dt><i>changedPaths</i></dt> +<dt><i>changedPaths</i> (list of dict)</dt> <dd> list of dictionary objects containing info about the changed files/directories </dd> -<dt><i>parents</i></dt> +<dt><i>parents</i> (list of int)</dt> <dd> -list of parent revisions (list of integers) +list of parent revisions </dd> -<dt><i>refnames</i></dt> +<dt><i>refnames</i> (str)</dt> <dd> -tags and branches of the commit (string) +tags and branches of the commit </dd> -<dt><i>authorMail</i></dt> +<dt><i>authorMail</i> (str)</dt> <dd> -author's email address (string) +author's email address </dd> -<dt><i>committerMail</i></dt> +<dt><i>committerMail</i> (str)</dt> <dd> -committer's email address (string) +committer's email address </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the generated item (QTreeWidgetItem) +reference to the generated item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem </dd> </dl> <a NAME="GitLogBrowserDialog.__generatorFinished" ID="GitLogBrowserDialog.__generatorFinished"></a> @@ -798,15 +825,21 @@ </p> <dl> -<dt><i>tag</i></dt> +<dt><i>tag</i> (str)</dt> <dd> -tag name (string) +tag name </dd> </dl> <dl> <dt>Return:</dt> <dd> -commit id shortened to 10 characters (string) +commit id shortened to 10 characters +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitLogBrowserDialog.__getLogEntries" ID="GitLogBrowserDialog.__getLogEntries"></a> @@ -818,13 +851,13 @@ </p> <dl> -<dt><i>skip</i></dt> +<dt><i>skip</i> (int)</dt> <dd> -number of log entries to skip (integer) +number of log entries to skip </dd> -<dt><i>noEntries</i></dt> +<dt><i>noEntries</i> (int)</dt> <dd> -number of entries to get (0 = default) (int) +number of entries to get (0 = default) </dd> </dl> <a NAME="GitLogBrowserDialog.__getTagsForCommit" ID="GitLogBrowserDialog.__getTagsForCommit"></a> @@ -891,7 +924,7 @@ </p> <dl> -<dt><i>fileSeparators</i></dt> +<dt><i>fileSeparators</i> (list of str)</dt> <dd> list of file separator entries to be merged </dd> @@ -902,6 +935,12 @@ merged list of file separator entries </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> <a NAME="GitLogBrowserDialog.__prepareFieldSearch" ID="GitLogBrowserDialog.__prepareFieldSearch"></a> <h4>GitLogBrowserDialog.__prepareFieldSearch</h4> <b>__prepareFieldSearch</b>(<i></i>) @@ -913,7 +952,13 @@ <dt>Return:</dt> <dd> tuple of field index, search expression and flag indicating - that the field index is a data role (integer, string, boolean) + that the field index is a data role +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, bool) </dd> </dl> <a NAME="GitLogBrowserDialog.__procFinished" ID="GitLogBrowserDialog.__procFinished"></a> @@ -925,13 +970,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitLogBrowserDialog.__processBuffer" ID="GitLogBrowserDialog.__processBuffer"></a> @@ -950,7 +995,7 @@ </p> <dl> -<dt><i>logEntry</i></dt> +<dt><i>logEntry</i> (dict)</dt> <dd> dictionary as generated by __processBuffer </dd> @@ -1034,9 +1079,9 @@ </p> <dl> -<dt><i>on</i></dt> +<dt><i>on</i> (bool)</dt> <dd> -flag indicating the selection state (boolean) +flag indicating the selection state </dd> </dl> <a NAME="GitLogBrowserDialog.__showBranchesColumn" ID="GitLogBrowserDialog.__showBranchesColumn"></a> @@ -1048,9 +1093,9 @@ </p> <dl> -<dt><i>on</i></dt> +<dt><i>on</i> (bool)</dt> <dd> -flag indicating the selection state (boolean) +flag indicating the selection state </dd> </dl> <a NAME="GitLogBrowserDialog.__showCommitIdColumn" ID="GitLogBrowserDialog.__showCommitIdColumn"></a> @@ -1062,9 +1107,9 @@ </p> <dl> -<dt><i>on</i></dt> +<dt><i>on</i> (bool)</dt> <dd> -flag indicating the selection state (boolean) +flag indicating the selection state </dd> </dl> <a NAME="GitLogBrowserDialog.__showCommitterColumns" ID="GitLogBrowserDialog.__showCommitterColumns"></a> @@ -1076,9 +1121,9 @@ </p> <dl> -<dt><i>on</i></dt> +<dt><i>on</i> (bool)</dt> <dd> -flag indicating the selection state (boolean) +flag indicating the selection state </dd> </dl> <a NAME="GitLogBrowserDialog.__showError" ID="GitLogBrowserDialog.__showError"></a> @@ -1090,9 +1135,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="GitLogBrowserDialog.__showTagsColumn" ID="GitLogBrowserDialog.__showTagsColumn"></a> @@ -1104,9 +1149,9 @@ </p> <dl> -<dt><i>on</i></dt> +<dt><i>on</i> (bool)</dt> <dd> -flag indicating the selection state (boolean) +flag indicating the selection state </dd> </dl> <a NAME="GitLogBrowserDialog.__switchActTriggered" ID="GitLogBrowserDialog.__switchActTriggered"></a> @@ -1169,9 +1214,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="GitLogBrowserDialog.col2x" ID="GitLogBrowserDialog.col2x"></a> @@ -1183,13 +1228,13 @@ </p> <dl> -<dt><i>col</i></dt> +<dt><i>col</i> (int)</dt> <dd> -column number (integer) +column number </dd> -<dt><i>radius</i></dt> +<dt><i>radius</i> (int)</dt> <dd> -radius of the indicator circle (integer) +radius of the indicator circle </dd> </dl> <a NAME="GitLogBrowserDialog.keyPressEvent" ID="GitLogBrowserDialog.keyPressEvent"></a> @@ -1201,9 +1246,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="GitLogBrowserDialog.on_buttonBox_clicked" ID="GitLogBrowserDialog.on_buttonBox_clicked"></a> @@ -1215,9 +1260,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitLogBrowserDialog.on_diffSelectLabel_linkActivated" ID="GitLogBrowserDialog.on_diffSelectLabel_linkActivated"></a> @@ -1264,13 +1309,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QTreeWidgetItem)</dt> <dd> -reference to the new current item (QTreeWidgetItem) +reference to the new current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QTreeWidgetItem)</dt> <dd> -reference to the old current item (QTreeWidgetItem) +reference to the old current item </dd> </dl> <a NAME="GitLogBrowserDialog.on_findNextButton_clicked" ID="GitLogBrowserDialog.on_findNextButton_clicked"></a> @@ -1296,9 +1341,9 @@ </p> <dl> -<dt><i>date</i></dt> +<dt><i>date</i> (QDate)</dt> <dd> -new date (QDate) +new date </dd> </dl> <a NAME="GitLogBrowserDialog.on_input_returnPressed" ID="GitLogBrowserDialog.on_input_returnPressed"></a> @@ -1317,13 +1362,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QTreeWidgetItem)</dt> <dd> -reference to the new current item (QTreeWidgetItem) +reference to the new current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QTreeWidgetItem)</dt> <dd> -reference to the old current item (QTreeWidgetItem) +reference to the old current item </dd> </dl> <a NAME="GitLogBrowserDialog.on_logTree_customContextMenuRequested" ID="GitLogBrowserDialog.on_logTree_customContextMenuRequested"></a> @@ -1335,9 +1380,9 @@ </p> <dl> -<dt><i>pos</i></dt> +<dt><i>pos</i> (QPoint)</dt> <dd> -position of the mouse pointer (QPoint) +position of the mouse pointer </dd> </dl> <a NAME="GitLogBrowserDialog.on_logTree_itemSelectionChanged" ID="GitLogBrowserDialog.on_logTree_itemSelectionChanged"></a> @@ -1356,9 +1401,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -index of the selected entry (integer) +index of the selected entry </dd> </dl> <a NAME="GitLogBrowserDialog.on_nextButton_clicked" ID="GitLogBrowserDialog.on_nextButton_clicked"></a> @@ -1377,9 +1422,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="GitLogBrowserDialog.on_refreshButton_clicked" ID="GitLogBrowserDialog.on_refreshButton_clicked"></a> @@ -1405,9 +1450,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -filter expression (string) +filter expression </dd> </dl> <a NAME="GitLogBrowserDialog.on_saveLabel_linkActivated" ID="GitLogBrowserDialog.on_saveLabel_linkActivated"></a> @@ -1454,9 +1499,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -flag indicating the state of the check box (boolean) +flag indicating the state of the check box </dd> </dl> <a NAME="GitLogBrowserDialog.on_toDate_dateChanged" ID="GitLogBrowserDialog.on_toDate_dateChanged"></a> @@ -1468,9 +1513,9 @@ </p> <dl> -<dt><i>date</i></dt> +<dt><i>date</i> (QDate)</dt> <dd> -new date (QDate) +new date </dd> </dl> <a NAME="GitLogBrowserDialog.on_upButton_clicked" ID="GitLogBrowserDialog.on_upButton_clicked"></a> @@ -1496,18 +1541,17 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to show the log for (string) +filename 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> -<dt><i>noEntries</i></dt> +<dt><i>noEntries</i> (int)</dt> <dd> -number of entries to get (0 = default) (int) +number of entries to get (0 = default) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitMergeDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitMergeDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -130,25 +130,25 @@ </p> <dl> -<dt><i>tagsList</i></dt> +<dt><i>tagsList</i> (list of str)</dt> <dd> -list of tags (list of strings) +list of tags </dd> -<dt><i>branchesList</i></dt> +<dt><i>branchesList</i> (list of str)</dt> <dd> -list of branches (list of strings) +list of branches </dd> -<dt><i>currentBranch</i></dt> +<dt><i>currentBranch</i> (str)</dt> <dd> -name of the current branch (string) +name of the current branch </dd> -<dt><i>remoteBranchesList</i></dt> +<dt><i>remoteBranchesList</i> (list of str)</dt> <dd> -list of remote branches (list of strings) +list of remote branches </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitMergeDialog.__generateDefaultCommitMessage" ID="GitMergeDialog.__generateDefaultCommitMessage"></a> @@ -179,8 +179,13 @@ tuple naming the revision, a flag indicating that the merge shall be committed, the commit message, a flag indicating that a log summary shall be appended and a flag indicating to show diff - statistics at the end of the merge (string, boolean, string, - boolean, boolean) + statistics at the end of the merge +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool, str, bool, bool) </dd> </dl> <a NAME="GitMergeDialog.on_branchButton_toggled" ID="GitMergeDialog.on_branchButton_toggled"></a> @@ -192,9 +197,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitMergeDialog.on_branchCombo_editTextChanged" ID="GitMergeDialog.on_branchCombo_editTextChanged"></a> @@ -206,9 +211,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="GitMergeDialog.on_commitGroupBox_toggled" ID="GitMergeDialog.on_commitGroupBox_toggled"></a> @@ -220,9 +225,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the group (boolean) +state of the group </dd> </dl> <a NAME="GitMergeDialog.on_commitMessageEdit_textChanged" ID="GitMergeDialog.on_commitMessageEdit_textChanged"></a> @@ -241,9 +246,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitMergeDialog.on_idEdit_textChanged" ID="GitMergeDialog.on_idEdit_textChanged"></a> @@ -255,9 +260,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="GitMergeDialog.on_noneButton_toggled" ID="GitMergeDialog.on_noneButton_toggled"></a> @@ -269,9 +274,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitMergeDialog.on_remoteBranchButton_toggled" ID="GitMergeDialog.on_remoteBranchButton_toggled"></a> @@ -283,9 +288,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitMergeDialog.on_remoteBranchCombo_editTextChanged" ID="GitMergeDialog.on_remoteBranchCombo_editTextChanged"></a> @@ -297,9 +302,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="GitMergeDialog.on_tagButton_toggled" ID="GitMergeDialog.on_tagButton_toggled"></a> @@ -311,9 +316,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitMergeDialog.on_tagCombo_editTextChanged" ID="GitMergeDialog.on_tagCombo_editTextChanged"></a> @@ -325,9 +330,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitNewProjectOptionsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitNewProjectOptionsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -104,13 +104,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the version control object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitNewProjectOptionsDialog.__saveHistory" ID="GitNewProjectOptionsDialog.__saveHistory"></a> @@ -131,7 +131,13 @@ <dt>Return:</dt> <dd> a tuple of a string (project directory) and a dictionary - containing the data entered. + containing the data entered +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, Any) </dd> </dl> <a NAME="GitNewProjectOptionsDialog.on_projectDirButton_clicked" ID="GitNewProjectOptionsDialog.on_projectDirButton_clicked"></a> @@ -150,9 +156,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -name of the project directory (string) +name of the project directory </dd> </dl> <a NAME="GitNewProjectOptionsDialog.on_vcsUrlButton_clicked" ID="GitNewProjectOptionsDialog.on_vcsUrlButton_clicked"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitOptionsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitOptionsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -80,17 +80,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the version control object </dd> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitOptionsDialog.getData" ID="GitOptionsDialog.getData"></a> @@ -106,6 +106,12 @@ a dictionary containing the data entered </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPatchFilesDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPatchFilesDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -102,18 +102,18 @@ </p> <dl> -<dt><i>rootDir</i></dt> +<dt><i>rootDir</i> (str)</dt> <dd> -root of the directory tree (string) +root of the directory tree </dd> -<dt><i>patchCheckData</i></dt> +<dt><i>patchCheckData</i> (tuple of (list of str, int, bool, bool))</dt> <dd> tuple of data as returned by the getData() method </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitPatchFilesDialog.__getPatchFilesList" ID="GitPatchFilesDialog.__getPatchFilesList"></a> @@ -126,7 +126,13 @@ <dl> <dt>Return:</dt> <dd> -list of patch files (list of string) +list of patch files +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="GitPatchFilesDialog.getData" ID="GitPatchFilesDialog.getData"></a> @@ -142,7 +148,12 @@ tuple of list of patch files, strip count, flag indicating that the patch has inaccurate end-of-file marker and a flag indicating to not trust the line count information - (list of string, integer, boolean, boolean) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, int, bool, bool) </dd> </dl> <a NAME="GitPatchFilesDialog.on_addButton_clicked" ID="GitPatchFilesDialog.on_addButton_clicked"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPatchStatisticsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPatchStatisticsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,13 +90,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the VCS object (Git) </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitPatchStatisticsDialog.__createStatisticsItem" ID="GitPatchStatisticsDialog.__createStatisticsItem"></a> @@ -108,9 +108,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -string with file statistics data (string) +string with file statistics data </dd> </dl> <a NAME="GitPatchStatisticsDialog.__resizeColumns" ID="GitPatchStatisticsDialog.__resizeColumns"></a> @@ -133,7 +133,12 @@ tuple of list of patch files, strip count, flag indicating that the patch has inaccurate end-of-file marker and a flag indicating to not trust the line count information - (list of string, integer, boolean, boolean) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, int, bool, bool) </dd> </dl> <a NAME="GitPatchStatisticsDialog.start" ID="GitPatchStatisticsDialog.start"></a> @@ -145,11 +150,11 @@ </p> <dl> -<dt><i>projectDir</i></dt> +<dt><i>projectDir</i> (str)</dt> <dd> -directory name of the project (string) +directory name of the project </dd> -<dt><i>patchCheckData</i></dt> +<dt><i>patchCheckData</i> (tuple of (list of str, int, bool, bool))</dt> <dd> tuple of data as returned by the GitPatchFilesDialog.getData() method
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPullDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPullDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -98,17 +98,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the git object </dd> -<dt><i>repodir</i></dt> +<dt><i>repodir</i> (str)</dt> <dd> -directory name of the local repository (string) +directory name of the local repository </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitPullDialog.__okButtonEnable" ID="GitPullDialog.__okButtonEnable"></a> @@ -138,7 +138,12 @@ tuple of remote name, remote url (for custom remotes), remote branches, a flag indicating to pull from all repositories and a flag indicating to remove obsolete tracking references - (string, string, list of strings, boolean, boolean) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, list of str, bool, bool) </dd> </dl> <a NAME="GitPullDialog.on_remoteEdit_textChanged" ID="GitPullDialog.on_remoteEdit_textChanged"></a> @@ -150,9 +155,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -current text of the URL edit (string) +current text of the URL edit </dd> </dl> <a NAME="GitPullDialog.on_remotesComboBox_currentTextChanged" ID="GitPullDialog.on_remotesComboBox_currentTextChanged"></a> @@ -164,9 +169,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -current text of the combo box (string) +current text of the combo box </dd> </dl> <a NAME="GitPullDialog.on_updateButton_clicked" ID="GitPullDialog.on_updateButton_clicked"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPushDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPushDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -94,17 +94,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the git object </dd> -<dt><i>repodir</i></dt> +<dt><i>repodir</i> (str)</dt> <dd> -directory name of the local repository (string) +directory name of the local repository </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitPushDialog.__resizeColumns" ID="GitPushDialog.__resizeColumns"></a> @@ -144,13 +144,13 @@ </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QTreeWidgetItem)</dt> <dd> -reference to the changed item (QTreeWidgetItem) +reference to the changed item </dd> -<dt><i>column</i></dt> +<dt><i>column</i> (int)</dt> <dd> -changed column (integer) +changed column </dd> </dl> <a NAME="GitPushDialog.on_remotesComboBox_currentTextChanged" ID="GitPushDialog.on_remotesComboBox_currentTextChanged"></a> @@ -162,9 +162,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -current text of the combo box (string) +current text of the combo box </dd> </dl> <a NAME="GitPushDialog.on_selectAllCheckBox_stateChanged" ID="GitPushDialog.on_selectAllCheckBox_stateChanged"></a> @@ -176,9 +176,9 @@ </p> <dl> -<dt><i>state</i></dt> +<dt><i>state</i> (Qt.CheckState)</dt> <dd> -check state of the check box (Qt.CheckState) +check state of the check box </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitReflogBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitReflogBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -158,13 +158,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitReflogBrowserDialog.__finish" ID="GitReflogBrowserDialog.__finish"></a> @@ -184,27 +184,33 @@ </p> <dl> -<dt><i>commitId</i></dt> +<dt><i>commitId</i> (str)</dt> <dd> -commit id info (string) +commit id info </dd> -<dt><i>selector</i></dt> +<dt><i>selector</i> (str)</dt> <dd> -selector info (string) +selector info </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name info (string) +name info </dd> -<dt><i>subject</i></dt> +<dt><i>subject</i> (str)</dt> <dd> -subject of the reflog entry (string) +subject of the reflog entry </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the generated item (QTreeWidgetItem) +reference to the generated item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem </dd> </dl> <a NAME="GitReflogBrowserDialog.__getReflogEntries" ID="GitReflogBrowserDialog.__getReflogEntries"></a> @@ -216,9 +222,9 @@ </p> <dl> -<dt><i>skip</i></dt> +<dt><i>skip</i> (int)</dt> <dd> -number of reflog entries to skip (integer) +number of reflog entries to skip </dd> </dl> <a NAME="GitReflogBrowserDialog.__initData" ID="GitReflogBrowserDialog.__initData"></a> @@ -237,13 +243,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitReflogBrowserDialog.__processBuffer" ID="GitReflogBrowserDialog.__processBuffer"></a> @@ -297,9 +303,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="GitReflogBrowserDialog.closeEvent" ID="GitReflogBrowserDialog.closeEvent"></a> @@ -311,9 +317,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="GitReflogBrowserDialog.keyPressEvent" ID="GitReflogBrowserDialog.keyPressEvent"></a> @@ -325,9 +331,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="GitReflogBrowserDialog.on_buttonBox_clicked" ID="GitReflogBrowserDialog.on_buttonBox_clicked"></a> @@ -339,9 +345,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitReflogBrowserDialog.on_input_returnPressed" ID="GitReflogBrowserDialog.on_input_returnPressed"></a> @@ -367,9 +373,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="GitReflogBrowserDialog.on_refreshButton_clicked" ID="GitReflogBrowserDialog.on_refreshButton_clicked"></a> @@ -402,9 +408,9 @@ </p> <dl> -<dt><i>projectdir</i></dt> +<dt><i>projectdir</i> (str)</dt> <dd> -directory name of the project (string) +directory name of the project </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitRemoteRepositoriesDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitRemoteRepositoriesDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -170,13 +170,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitRemoteRepositoriesDialog.__finish" ID="GitRemoteRepositoriesDialog.__finish"></a> @@ -196,17 +196,17 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the remote repository (string) +name of the remote repository </dd> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -URL of the remote repository (string) +URL of the remote repository </dd> -<dt><i>oper</i></dt> +<dt><i>oper</i> (str)</dt> <dd> -operation the remote repository may be used for (string) +operation the remote repository may be used for </dd> </dl> <a NAME="GitRemoteRepositoriesDialog.__procFinished" ID="GitRemoteRepositoriesDialog.__procFinished"></a> @@ -218,13 +218,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitRemoteRepositoriesDialog.__readStderr" ID="GitRemoteRepositoriesDialog.__readStderr"></a> @@ -279,9 +279,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="GitRemoteRepositoriesDialog.keyPressEvent" ID="GitRemoteRepositoriesDialog.keyPressEvent"></a> @@ -293,9 +293,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="GitRemoteRepositoriesDialog.on_addButton_clicked" ID="GitRemoteRepositoriesDialog.on_addButton_clicked"></a> @@ -314,9 +314,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitRemoteRepositoriesDialog.on_changeUrlButton_clicked" ID="GitRemoteRepositoriesDialog.on_changeUrlButton_clicked"></a> @@ -349,9 +349,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="GitRemoteRepositoriesDialog.on_pruneButton_clicked" ID="GitRemoteRepositoriesDialog.on_pruneButton_clicked"></a> @@ -412,9 +412,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> +<dt><i>projectDir</i> (str)</dt> <dd> -name of the project directory (string) +name of the project directory </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitRevisionSelectionDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitRevisionSelectionDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -114,34 +114,33 @@ </p> <dl> -<dt><i>tagsList</i></dt> +<dt><i>tagsList</i> (list of str)</dt> <dd> -list of tags (list of strings) +list of tags </dd> -<dt><i>branchesList</i></dt> +<dt><i>branchesList</i> (list of str)</dt> <dd> -list of branches (list of strings) +list of branches </dd> -<dt><i>trackingBranchesList</i></dt> +<dt><i>trackingBranchesList</i> (list of str)</dt> <dd> -list of remote branches (list of strings) +list of remote branches </dd> -<dt><i>noneLabel</i></dt> +<dt><i>noneLabel</i> (str)</dt> <dd> -label text for "no revision selected" (string) +label text for "no revision selected" </dd> -<dt><i>showBranches</i></dt> +<dt><i>showBranches</i> (bool)</dt> <dd> flag indicating to show the branch selection - (boolean) </dd> -<dt><i>showHead</i></dt> +<dt><i>showHead</i> (bool)</dt> <dd> -flag indicating to show the head selection (boolean) +flag indicating to show the head selection </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitRevisionSelectionDialog.__updateOK" ID="GitRevisionSelectionDialog.__updateOK"></a> @@ -161,7 +160,13 @@ <dl> <dt>Return:</dt> <dd> -selected revision (string) +selected revision +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitRevisionSelectionDialog.on_branchButton_toggled" ID="GitRevisionSelectionDialog.on_branchButton_toggled"></a> @@ -173,9 +178,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitRevisionSelectionDialog.on_branchCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_branchCombo_editTextChanged"></a> @@ -187,9 +192,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="GitRevisionSelectionDialog.on_remoteBranchButton_toggled" ID="GitRevisionSelectionDialog.on_remoteBranchButton_toggled"></a> @@ -201,9 +206,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_remoteBranchCombo_editTextChanged"></a> @@ -215,9 +220,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="GitRevisionSelectionDialog.on_revButton_toggled" ID="GitRevisionSelectionDialog.on_revButton_toggled"></a> @@ -229,9 +234,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitRevisionSelectionDialog.on_revEdit_textChanged" ID="GitRevisionSelectionDialog.on_revEdit_textChanged"></a> @@ -243,9 +248,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="GitRevisionSelectionDialog.on_tagButton_toggled" ID="GitRevisionSelectionDialog.on_tagButton_toggled"></a> @@ -257,9 +262,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitRevisionSelectionDialog.on_tagCombo_editTextChanged" ID="GitRevisionSelectionDialog.on_tagCombo_editTextChanged"></a> @@ -271,9 +276,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitRevisionsSelectionDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitRevisionsSelectionDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -135,17 +135,17 @@ </p> <dl> -<dt><i>tagsList</i></dt> +<dt><i>tagsList</i> (list of str)</dt> <dd> -list of tags (list of strings) +list of tags </dd> -<dt><i>branchesList</i></dt> +<dt><i>branchesList</i> (list of str)</dt> <dd> -list of branches (list of strings) +list of branches </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of the dialog (QWidget) +parent widget of the dialog </dd> </dl> <a NAME="GitRevisionsSelectionDialog.__getRevision" ID="GitRevisionsSelectionDialog.__getRevision"></a> @@ -157,7 +157,7 @@ </p> <dl> -<dt><i>no</i></dt> +<dt><i>no</i> (int)</dt> <dd> revision number to generate (1 or 2) </dd> @@ -165,7 +165,13 @@ <dl> <dt>Return:</dt> <dd> -revision (string) +revision +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitRevisionsSelectionDialog.__updateOK" ID="GitRevisionsSelectionDialog.__updateOK"></a> @@ -185,7 +191,13 @@ <dl> <dt>Return:</dt> <dd> -list of two revisions (list of strings) +list of two revisions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_branch1Button_toggled" ID="GitRevisionsSelectionDialog.on_branch1Button_toggled"></a> @@ -197,9 +209,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_branch1Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_branch1Combo_editTextChanged"></a> @@ -211,9 +223,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_branch2Button_toggled" ID="GitRevisionsSelectionDialog.on_branch2Button_toggled"></a> @@ -225,9 +237,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_branch2Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_branch2Combo_editTextChanged"></a> @@ -239,9 +251,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_rev1Button_toggled" ID="GitRevisionsSelectionDialog.on_rev1Button_toggled"></a> @@ -253,9 +265,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_rev1Edit_textChanged" ID="GitRevisionsSelectionDialog.on_rev1Edit_textChanged"></a> @@ -267,9 +279,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_rev2Button_toggled" ID="GitRevisionsSelectionDialog.on_rev2Button_toggled"></a> @@ -281,9 +293,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_rev2Edit_textChanged" ID="GitRevisionsSelectionDialog.on_rev2Edit_textChanged"></a> @@ -295,9 +307,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_tag1Button_toggled" ID="GitRevisionsSelectionDialog.on_tag1Button_toggled"></a> @@ -309,9 +321,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_tag1Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_tag1Combo_editTextChanged"></a> @@ -323,9 +335,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_tag2Button_toggled" ID="GitRevisionsSelectionDialog.on_tag2Button_toggled"></a> @@ -337,9 +349,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="GitRevisionsSelectionDialog.on_tag2Combo_editTextChanged" ID="GitRevisionsSelectionDialog.on_tag2Combo_editTextChanged"></a> @@ -351,9 +363,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStashBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStashBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -178,13 +178,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitStashBrowserDialog.__apply" ID="GitStashBrowserDialog.__apply"></a> @@ -232,17 +232,17 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the stash (string) +name of the stash </dd> -<dt><i>date</i></dt> +<dt><i>date</i> (str)</dt> <dd> -date the stash was created (string) +date the stash was created </dd> -<dt><i>message</i></dt> +<dt><i>message</i> (str)</dt> <dd> -stash message (string) +stash message </dd> </dl> <a NAME="GitStashBrowserDialog.__getStashEntries" ID="GitStashBrowserDialog.__getStashEntries"></a> @@ -268,13 +268,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitStashBrowserDialog.__processBuffer" ID="GitStashBrowserDialog.__processBuffer"></a> @@ -335,9 +335,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="GitStashBrowserDialog.keyPressEvent" ID="GitStashBrowserDialog.keyPressEvent"></a> @@ -349,9 +349,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="GitStashBrowserDialog.on_buttonBox_clicked" ID="GitStashBrowserDialog.on_buttonBox_clicked"></a> @@ -363,9 +363,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitStashBrowserDialog.on_input_returnPressed" ID="GitStashBrowserDialog.on_input_returnPressed"></a> @@ -384,9 +384,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="GitStashBrowserDialog.on_refreshButton_clicked" ID="GitStashBrowserDialog.on_refreshButton_clicked"></a> @@ -412,13 +412,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QTreeWidgetItem)</dt> <dd> -reference to the new current item (QTreeWidgetItem) +reference to the new current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QTreeWidgetItem)</dt> <dd> -reference to the old current item (QTreeWidgetItem) +reference to the old current item </dd> </dl> <a NAME="GitStashBrowserDialog.on_stashList_customContextMenuRequested" ID="GitStashBrowserDialog.on_stashList_customContextMenuRequested"></a> @@ -430,9 +430,9 @@ </p> <dl> -<dt><i>pos</i></dt> +<dt><i>pos</i> (QPoint)</dt> <dd> -position of the mouse pointer (QPoint) +position of the mouse pointer </dd> </dl> <a NAME="GitStashBrowserDialog.show" ID="GitStashBrowserDialog.show"></a> @@ -451,9 +451,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> +<dt><i>projectDir</i> (str)</dt> <dd> -name of the project directory (string) +name of the project directory </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStashDataDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStashDataDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,9 +78,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitStashDataDialog.getData" ID="GitStashDataDialog.getData"></a> @@ -93,9 +93,15 @@ <dl> <dt>Return:</dt> <dd> -tuple containing the message (string), a flag indicating to - keep changes in the staging area (boolean) and an indication to - stash untracked and/or ignored files (integer) +tuple containing the message, a flag indicating to keep changes + in the staging area and an indication to stash untracked and/or + ignored files +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool, int) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -292,13 +292,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitStatusDialog.__add" ID="GitStatusDialog.__add"></a> @@ -324,9 +324,9 @@ </p> <dl> -<dt><i>amend</i></dt> +<dt><i>amend</i> (bool)</dt> <dd> -flag indicating to perform an amend operation (boolean) +flag indicating to perform an amend operation </dd> </dl> <a NAME="GitStatusDialog.__commitDeselectAll" ID="GitStatusDialog.__commitDeselectAll"></a> @@ -345,9 +345,9 @@ </p> <dl> -<dt><i>selected</i></dt> +<dt><i>selected</i> (bool)</dt> <dd> -commit selection state to be set (boolean) +commit selection state to be set </dd> </dl> <a NAME="GitStatusDialog.__commitSelectAll" ID="GitStatusDialog.__commitSelectAll"></a> @@ -409,13 +409,13 @@ </p> <dl> -<dt><i>status</i></dt> +<dt><i>status</i> (str)</dt> <dd> -status indicator (string) +status indicator </dd> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -path of the file or directory (string) +path of the file or directory </dd> </dl> <a NAME="GitStatusDialog.__generatorFinished" ID="GitStatusDialog.__generatorFinished"></a> @@ -438,6 +438,12 @@ list of all items, the user has checked </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="GitStatusDialog.__getCommitableUnselectedItems" ID="GitStatusDialog.__getCommitableUnselectedItems"></a> <h4>GitStatusDialog.__getCommitableUnselectedItems</h4> <b>__getCommitableUnselectedItems</b>(<i></i>) @@ -452,6 +458,12 @@ list of all items, the user has not checked </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="GitStatusDialog.__getConflictingItems" ID="GitStatusDialog.__getConflictingItems"></a> <h4>GitStatusDialog.__getConflictingItems</h4> <b>__getConflictingItems</b>(<i></i>) @@ -465,6 +477,12 @@ list of all items with a conflict status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="GitStatusDialog.__getMissingItems" ID="GitStatusDialog.__getMissingItems"></a> <h4>GitStatusDialog.__getMissingItems</h4> <b>__getMissingItems</b>(<i></i>) @@ -478,6 +496,12 @@ list of all items with a missing status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="GitStatusDialog.__getModifiedItems" ID="GitStatusDialog.__getModifiedItems"></a> <h4>GitStatusDialog.__getModifiedItems</h4> <b>__getModifiedItems</b>(<i></i>) @@ -491,6 +515,12 @@ list of all items with a modified status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="GitStatusDialog.__getModifiedOnlyItems" ID="GitStatusDialog.__getModifiedOnlyItems"></a> <h4>GitStatusDialog.__getModifiedOnlyItems</h4> <b>__getModifiedOnlyItems</b>(<i></i>) @@ -504,6 +534,12 @@ list of all items with a modified status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="GitStatusDialog.__getStageableItems" ID="GitStatusDialog.__getStageableItems"></a> <h4>GitStatusDialog.__getStageableItems</h4> <b>__getStageableItems</b>(<i></i>) @@ -518,6 +554,12 @@ list of all items with a stageable status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="GitStatusDialog.__getUnstageableItems" ID="GitStatusDialog.__getUnstageableItems"></a> <h4>GitStatusDialog.__getUnstageableItems</h4> <b>__getUnstageableItems</b>(<i></i>) @@ -532,6 +574,12 @@ list of all items with an unstageable status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="GitStatusDialog.__getUnversionedItems" ID="GitStatusDialog.__getUnversionedItems"></a> <h4>GitStatusDialog.__getUnversionedItems</h4> <b>__getUnversionedItems</b>(<i></i>) @@ -546,6 +594,12 @@ list of all items with an unversioned status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="GitStatusDialog.__initActionsMenu" ID="GitStatusDialog.__initActionsMenu"></a> <h4>GitStatusDialog.__initActionsMenu</h4> <b>__initActionsMenu</b>(<i></i>) @@ -562,13 +616,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitStatusDialog.__readStderr" ID="GitStatusDialog.__readStderr"></a> @@ -651,15 +705,21 @@ </p> <dl> -<dt><i>diffEdit</i></dt> +<dt><i>diffEdit</i> (QTextEdit)</dt> <dd> -reference to the edit widget (QTextEdit) +reference to the edit widget </dd> </dl> <dl> <dt>Return:</dt> <dd> -tuple of start and end indexes (integer, integer) +tuple of start and end indexes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int) </dd> </dl> <a NAME="GitStatusDialog.__showActionsMenu" ID="GitStatusDialog.__showActionsMenu"></a> @@ -678,9 +738,9 @@ </p> <dl> -<dt><i>coord</i></dt> +<dt><i>coord</i> (QPoint)</dt> <dd> -position of the mouse pointer (QPoint) +position of the mouse pointer </dd> </dl> <a NAME="GitStatusDialog.__showRDiffContextMenu" ID="GitStatusDialog.__showRDiffContextMenu"></a> @@ -692,9 +752,9 @@ </p> <dl> -<dt><i>coord</i></dt> +<dt><i>coord</i> (QPoint)</dt> <dd> -position of the mouse pointer (QPoint) +position of the mouse pointer </dd> </dl> <a NAME="GitStatusDialog.__stage" ID="GitStatusDialog.__stage"></a> @@ -721,7 +781,13 @@ <dl> <dt>Return:</dt> <dd> -name of the temporary file (string) +name of the temporary file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="GitStatusDialog.__unstage" ID="GitStatusDialog.__unstage"></a> @@ -747,9 +813,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="GitStatusDialog.keyPressEvent" ID="GitStatusDialog.keyPressEvent"></a> @@ -761,9 +827,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="GitStatusDialog.on_buttonBox_clicked" ID="GitStatusDialog.on_buttonBox_clicked"></a> @@ -775,9 +841,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitStatusDialog.on_input_returnPressed" ID="GitStatusDialog.on_input_returnPressed"></a> @@ -796,9 +862,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="GitStatusDialog.on_refreshButton_clicked" ID="GitStatusDialog.on_refreshButton_clicked"></a> @@ -852,10 +918,9 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str or list of str)</dt> <dd> filename(s)/directoryname(s) to show the status of - (string or list of strings) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread.html Sat Dec 23 15:40:23 2023 +0100 @@ -86,21 +86,21 @@ </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 (Project) +reference to the project object </dd> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Git)</dt> <dd> reference to the version control object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QObject)</dt> <dd> -reference to the parent object (QObject) +reference to the parent object </dd> </dl> <a NAME="GitStatusMonitorThread._getInfo" ID="GitStatusMonitorThread._getInfo"></a> @@ -153,8 +153,14 @@ <dl> <dt>Return:</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="GitStatusMonitorThread._shutdown" ID="GitStatusMonitorThread._shutdown"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesStatusDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesStatusDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -132,9 +132,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="GitSubmodulesStatusDialog.on_indexCheckBox_toggled" ID="GitSubmodulesStatusDialog.on_indexCheckBox_toggled"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitTagDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitTagDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -82,21 +82,21 @@ </p> <dl> -<dt><i>taglist</i></dt> +<dt><i>taglist</i> (list of str)</dt> <dd> -list of previously entered tags (list of strings) +list of previously entered tags </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision to set tag for (string) +revision to set tag for </dd> -<dt><i>tagName</i></dt> +<dt><i>tagName</i> (str)</dt> <dd> -name of the tag (string) +name of the tag </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="GitTagDialog.getParameters" ID="GitTagDialog.getParameters"></a> @@ -109,8 +109,14 @@ <dl> <dt>Return:</dt> <dd> -tuple of two strings, two int and a boolean (tag, revision, - tag operation, tag type, enforce operation) +tuple containing the tag, revision, tag operation, tag type, + and a flag indicating to enforce the operation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, int, int, bool) </dd> </dl> <a NAME="GitTagDialog.on_tagCombo_editTextChanged" ID="GitTagDialog.on_tagCombo_editTextChanged"></a> @@ -122,9 +128,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -tag name entered in the combo (string) +tag name entered in the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitUserConfigDataDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitUserConfigDataDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,13 +78,13 @@ </p> <dl> -<dt><i>version</i></dt> +<dt><i>version</i> (tuple of (int, int))</dt> <dd> -Git version info (tuple of two integers) +Git version info </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="GitUserConfigDataDialog.getData" ID="GitUserConfigDataDialog.getData"></a> @@ -98,7 +98,12 @@ <dt>Return:</dt> <dd> tuple with user's first name, last name and email address - (tuple of three strings) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, str) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitUtilities.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitUtilities.html Sat Dec 23 15:40:23 2023 +0100 @@ -46,7 +46,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the config file (string) +filename of the config file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -61,13 +67,13 @@ </p> <dl> -<dt><i>proc</i></dt> +<dt><i>proc</i> (QProcess)</dt> <dd> -reference to the process to be prepared (QProcess) +reference to the process to be prepared </dd> -<dt><i>language</i></dt> +<dt><i>language</i> (str)</dt> <dd> -language to be set (string) +language to be set </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -222,13 +222,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="GitWorktreeDialog.__readStderr" ID="GitWorktreeDialog.__readStderr"></a> @@ -368,9 +368,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="GitWorktreeDialog.on_buttonBox_clicked" ID="GitWorktreeDialog.on_buttonBox_clicked"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.ProjectBrowserHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.ProjectBrowserHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -162,30 +162,30 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>browserObject</i></dt> +<dt><i>browserObject</i> (ProjectBaseBrowser)</dt> <dd> reference to the project browser object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</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) </dd> -<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="GitProjectBrowserHelper.__GitBlame" ID="GitProjectBrowserHelper.__GitBlame"></a> @@ -312,7 +312,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -326,7 +326,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -340,7 +340,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -354,7 +354,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -369,7 +369,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -387,11 +387,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -410,11 +410,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -433,11 +433,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -457,11 +457,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -410,21 +410,21 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</i> (Project)</dt> <dd> reference to the project object </dd> -<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="GitProjectHelper.__gitAddRemote" ID="GitProjectHelper.__gitAddRemote"></a> @@ -976,7 +976,13 @@ <dl> <dt>Return:</dt> <dd> -list of all actions (list of EricAction) +list of all actions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of EricAction </dd> </dl> <a NAME="GitProjectHelper.getProject" ID="GitProjectHelper.getProject"></a> @@ -989,7 +995,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the project object (Project) +reference to the project object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +Project </dd> </dl> <a NAME="GitProjectHelper.initActions" ID="GitProjectHelper.initActions"></a> @@ -1008,9 +1020,9 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu to be populated (QMenu) +reference to the menu to be populated </dd> </dl> <a NAME="GitProjectHelper.initToolbar" ID="GitProjectHelper.initToolbar"></a> @@ -1022,14 +1034,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <a NAME="GitProjectHelper.removeToolbar" ID="GitProjectHelper.removeToolbar"></a> @@ -1041,14 +1052,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <a NAME="GitProjectHelper.setObjects" ID="GitProjectHelper.setObjects"></a> @@ -1060,11 +1070,11 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Git)</dt> <dd> reference to the vcs object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</i> (Project)</dt> <dd> reference to the project object </dd>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.git.html Sat Dec 23 15:40:23 2023 +0100 @@ -586,17 +586,17 @@ </p> <dl> -<dt><i>plugin</i></dt> +<dt><i>plugin</i> (VcsGitPlugin)</dt> <dd> reference to the plugin object </dd> -<dt><i>parent</i></dt> -<dd> -parent widget (QWidget) -</dd> -<dt><i>name</i></dt> -<dd> -name of this object (string) +<dt><i>parent</i> (QWidget)</dt> +<dd> +parent widget +</dd> +<dt><i>name</i> (str)</dt> +<dd> +name of this object </dd> </dl> <a NAME="Git.__gitGetFileForRevision" ID="Git.__gitGetFileForRevision"></a> @@ -609,19 +609,25 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file name to get from the repository (string) -</dd> -<dt><i>rev</i></dt> -<dd> -revision to retrieve (string) +<dt><i>name</i> (str)</dt> +<dd> +file name to get from the repository +</dd> +<dt><i>rev</i> (str)</dt> +<dd> +revision to retrieve </dd> </dl> <dl> <dt>Return:</dt> <dd> -contents of the file (string) and an error message (string) +contents of the file (string) and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Git.__gitGetStashesList" ID="Git.__gitGetStashesList"></a> @@ -633,15 +639,21 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of available stashes (list of string) +list of available stashes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Git.__gitSubmodulesList" ID="Git.__gitSubmodulesList"></a> @@ -741,20 +753,25 @@ </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> -<dd> -reference to the project object (Project) +</dd> +<dt><i>project</i> (Project)</dt> +<dd> +reference to the project object </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the monitor thread (QThread) +reference to the monitor thread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +GitStatusMonitorThread </dd> </dl> <a NAME="Git.clearStatusCache" ID="Git.clearStatusCache"></a> @@ -800,7 +817,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the plugin object (VcsGitPlugin) +reference to the plugin object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +VcsGitPlugin </dd> </dl> <a NAME="Git.gitAddRemote" ID="Git.gitAddRemote"></a> @@ -812,9 +835,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitApply" ID="Git.gitApply"></a> @@ -826,26 +849,25 @@ </p> <dl> -<dt><i>repodir</i></dt> -<dd> -directory name of the repository (string) -</dd> -<dt><i>patchFile</i></dt> -<dd> -name of the patch file (string) -</dd> -<dt><i>cached</i></dt> +<dt><i>repodir</i> (str)</dt> +<dd> +directory name of the repository +</dd> +<dt><i>patchFile</i> (str)</dt> +<dd> +name of the patch file +</dd> +<dt><i>cached</i> (bool)</dt> <dd> flag indicating to apply the patch to the staging area - (boolean) -</dd> -<dt><i>reverse</i></dt> -<dd> -flag indicating to apply the patch in reverse (boolean) -</dd> -<dt><i>noDialog</i></dt> -<dd> -flag indicating quiet operations (boolean) +</dd> +<dt><i>reverse</i> (bool)</dt> +<dd> +flag indicating to apply the patch in reverse +</dd> +<dt><i>noDialog</i> (bool)</dt> +<dd> +flag indicating quiet operations </dd> </dl> <a NAME="Git.gitApplyCheckPatches" ID="Git.gitApplyCheckPatches"></a> @@ -858,13 +880,13 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -directory name of the project (string) -</dd> -<dt><i>check</i></dt> -<dd> -flag indicating to perform a check operation (boolean) +<dt><i>projectDir</i> (str)</dt> +<dd> +directory name of the project +</dd> +<dt><i>check</i> (bool)</dt> +<dd> +flag indicating to perform a check operation </dd> </dl> <a NAME="Git.gitBisect" ID="Git.gitBisect"></a> @@ -876,21 +898,26 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>subcommand</i></dt> -<dd> -name of the subcommand (string, one of 'start', +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>subcommand</i> (str)</dt> +<dd> +name of the subcommand (one of 'start', 'start_extended', 'good', 'bad', 'skip' or 'reset') </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the update contained an add - or delete (boolean) +flag indicating, that the update contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <dl> @@ -909,9 +936,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitBisectEditReplayFile" ID="Git.gitBisectEditReplayFile"></a> @@ -923,9 +950,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitBisectLogBrowser" ID="Git.gitBisectLogBrowser"></a> @@ -937,9 +964,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitBisectReplay" ID="Git.gitBisectReplay"></a> @@ -951,16 +978,21 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the update contained an add - or delete (boolean) +flag indicating, that the update contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitBlame" ID="Git.gitBlame"></a> @@ -991,29 +1023,34 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be branched (string) -</dd> -<dt><i>revision</i></dt> -<dd> -revision to set tag for (string) -</dd> -<dt><i>branchName</i></dt> -<dd> -name of the branch (string) -</dd> -<dt><i>branchOp</i></dt> -<dd> -desired branch operation (integer) +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be branched +</dd> +<dt><i>revision</i> (str)</dt> +<dd> +revision to set tag for +</dd> +<dt><i>branchName</i> (str)</dt> +<dd> +name of the branch +</dd> +<dt><i>branchOp</i> (int)</dt> +<dd> +desired branch operation </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a performed branch action (boolean) and - a flag indicating, that the branch operation contained an add - or delete (boolean) +flag indicating a performed branch action and a flag indicating, + that the branch operation contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, bool) </dd> </dl> <a NAME="Git.gitBundle" ID="Git.gitBundle"></a> @@ -1025,9 +1062,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitBundleFetch" ID="Git.gitBundleFetch"></a> @@ -1040,9 +1077,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitBundleListHeads" ID="Git.gitBundleListHeads"></a> @@ -1054,9 +1091,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitBundlePull" ID="Git.gitBundlePull"></a> @@ -1069,16 +1106,21 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the update contained an add - or delete (boolean) +flag indicating, that the update contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitCancelMerge" ID="Git.gitCancelMerge"></a> @@ -1090,16 +1132,21 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name (string) +<dt><i>name</i> (str)</dt> +<dd> +file/directory name </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the cancellation contained an add - or delete (boolean) +flag indicating, that the cancellation contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitChangeRemoteCredentials" ID="Git.gitChangeRemoteCredentials"></a> @@ -1156,19 +1203,25 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>commits</i></dt> -<dd> -list of commits to be applied (list of strings) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>commits</i> (list of str)</dt> +<dd> +list of commits to be applied </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitCherryPickAbort" ID="Git.gitCherryPickAbort"></a> @@ -1181,15 +1234,21 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitCherryPickContinue" ID="Git.gitCherryPickContinue"></a> @@ -1202,15 +1261,21 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitCherryPickQuit" ID="Git.gitCherryPickQuit"></a> @@ -1222,15 +1287,21 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitCommitMerge" ID="Git.gitCommitMerge"></a> @@ -1242,9 +1313,9 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name (string) +<dt><i>name</i> (str)</dt> +<dd> +file/directory name </dd> </dl> <a NAME="Git.gitCopy" ID="Git.gitCopy"></a> @@ -1256,11 +1327,11 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be copied (string) -</dd> -<dt><i>project</i></dt> +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be copied +</dd> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> @@ -1268,7 +1339,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating successful operation (boolean) +flag indicating successful operation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitCreateArchive" ID="Git.gitCreateArchive"></a> @@ -1280,9 +1357,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitCreateIgnoreFile" ID="Git.gitCreateIgnoreFile"></a> @@ -1294,13 +1371,13 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -directory name to create the ignore file in (string) -</dd> -<dt><i>autoAdd</i></dt> -<dd> -flag indicating to add it automatically (boolean) +<dt><i>name</i> (str)</dt> +<dd> +directory name to create the ignore file in +</dd> +<dt><i>autoAdd</i> (bool)</dt> +<dd> +flag indicating to add it automatically </dd> </dl> <dl> @@ -1309,6 +1386,12 @@ flag indicating success </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="Git.gitDeleteRemoteBranch" ID="Git.gitDeleteRemoteBranch"></a> <h4>Git.gitDeleteRemoteBranch</h4> <b>gitDeleteRemoteBranch</b>(<i>name</i>) @@ -1318,9 +1401,9 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name (string) +<dt><i>name</i> (str)</dt> +<dd> +file/directory name </dd> </dl> <a NAME="Git.gitDescribe" ID="Git.gitDescribe"></a> @@ -1332,14 +1415,13 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>commits</i></dt> +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>commits</i> (list of str)</dt> <dd> list of commits to start the search from - (list of strings) </dd> </dl> <a NAME="Git.gitEditConfig" ID="Git.gitEditConfig"></a> @@ -1351,9 +1433,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitEditUserConfig" ID="Git.gitEditUserConfig"></a> @@ -1382,9 +1464,9 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be diffed (string) +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be diffed </dd> </dl> <a NAME="Git.gitFetch" ID="Git.gitFetch"></a> @@ -1396,9 +1478,9 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -directory name (string) +<dt><i>name</i> (str)</dt> +<dd> +directory name </dd> </dl> <a NAME="Git.gitGetArchiveFormats" ID="Git.gitGetArchiveFormats"></a> @@ -1410,15 +1492,21 @@ </p> <dl> -<dt><i>repodir</i></dt> -<dd> -directory name of the repository (string) +<dt><i>repodir</i> (str)</dt> +<dd> +directory name of the repository </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of supported archive formats (list of strings) +list of supported archive formats +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Git.gitGetBranchesList" ID="Git.gitGetBranchesList"></a> @@ -1430,27 +1518,33 @@ </p> <dl> -<dt><i>repodir</i></dt> -<dd> -directory name of the repository (string) -</dd> -<dt><i>withMain</i></dt> -<dd> -flag indicating to get 'main' as well (boolean) -</dd> -<dt><i>allBranches</i></dt> -<dd> -flag indicating to return all branches (boolean) -</dd> -<dt><i>remotes</i></dt> -<dd> -flag indicating to return remote branches only (boolean) +<dt><i>repodir</i> (str)</dt> +<dd> +directory name of the repository +</dd> +<dt><i>withMain</i> (bool)</dt> +<dd> +flag indicating to get 'main' as well +</dd> +<dt><i>allBranches</i> (bool)</dt> +<dd> +flag indicating to return all branches +</dd> +<dt><i>remotes</i> (bool)</dt> +<dd> +flag indicating to return remote branches only </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of branches (list of string) +list of branches +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Git.gitGetBundleHeads" ID="Git.gitGetBundleHeads"></a> @@ -1462,19 +1556,25 @@ </p> <dl> -<dt><i>repodir</i></dt> -<dd> -directory name of the repository (string) -</dd> -<dt><i>bundleFile</i></dt> -<dd> -file name of a git bundle file (string) +<dt><i>repodir</i> (str)</dt> +<dd> +directory name of the repository +</dd> +<dt><i>bundleFile</i> (str)</dt> +<dd> +file name of a git bundle file </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of heads (list of strings) +list of heads +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Git.gitGetCurrentBranch" ID="Git.gitGetCurrentBranch"></a> @@ -1486,15 +1586,21 @@ </p> <dl> -<dt><i>repodir</i></dt> -<dd> -directory name of the repository (string) +<dt><i>repodir</i> (str)</dt> +<dd> +directory name of the repository </dd> </dl> <dl> <dt>Return:</dt> <dd> -name of the current branch (string) +name of the current branch +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Git.gitGetRemoteBranchesList" ID="Git.gitGetRemoteBranchesList"></a> @@ -1506,19 +1612,25 @@ </p> <dl> -<dt><i>repodir</i></dt> -<dd> -directory name of the repository (string) -</dd> -<dt><i>remote</i></dt> -<dd> -remote repository name (string) +<dt><i>repodir</i> (str)</dt> +<dd> +directory name of the repository +</dd> +<dt><i>remote</i> (str)</dt> +<dd> +remote repository name </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of remote repository branches (list of string) +list of remote repository branches +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Git.gitGetRemoteUrl" ID="Git.gitGetRemoteUrl"></a> @@ -1560,20 +1672,25 @@ </p> <dl> -<dt><i>repodir</i></dt> -<dd> -directory name of the repository (string) -</dd> -<dt><i>forFetch</i></dt> -<dd> -flag indicating to get Fetch info (string) +<dt><i>repodir</i> (str)</dt> +<dd> +directory name of the repository +</dd> +<dt><i>forFetch</i> (str)</dt> +<dd> +flag indicating to get Fetch info </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of tuples of remote repo name and repo URL (list of - tuple of two strings) +list of tuples of remote repo name and repo URL +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of [(str, str)] </dd> </dl> <a NAME="Git.gitGetRemotesList" ID="Git.gitGetRemotesList"></a> @@ -1585,15 +1702,21 @@ </p> <dl> -<dt><i>repodir</i></dt> -<dd> -directory name of the repository (string) +<dt><i>repodir</i> (str)</dt> +<dd> +directory name of the repository </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of remote repos (list of string) +list of remote repos +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a> @@ -1605,17 +1728,22 @@ </p> <dl> -<dt><i>repodir</i></dt> -<dd> -directory name of the repository (string) +<dt><i>repodir</i> (str)</dt> +<dd> +directory name of the repository </dd> </dl> <dl> <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 - and boolean), if withType is True +list of tags or list of tuples of tag name and flag indicating + a local tag, if withType is True +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str or list of tuple of (str, bool) </dd> </dl> <a NAME="Git.gitHouseKeeping" ID="Git.gitHouseKeeping"></a> @@ -1627,9 +1755,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitListTagBranch" ID="Git.gitListTagBranch"></a> @@ -1641,23 +1769,22 @@ </p> <dl> -<dt><i>path</i></dt> -<dd> -directory name of the project (string) -</dd> -<dt><i>tags</i></dt> +<dt><i>path</i> (str)</dt> +<dd> +directory name of the project +</dd> +<dt><i>tags</i> (bool)</dt> <dd> flag indicating listing of branches or tags (False = branches, True = tags) </dd> -<dt><i>listAll</i></dt> -<dd> -flag indicating to show all tags or branches (boolean) -</dd> -<dt><i>merged</i></dt> -<dd> -flag indicating to show only merged or non-merged - branches (boolean) +<dt><i>listAll</i> (bool)</dt> +<dd> +flag indicating to show all tags or branches +</dd> +<dt><i>merged</i> (bool)</dt> +<dd> +flag indicating to show only merged or non-merged branches </dd> </dl> <a NAME="Git.gitNormalizeURL" ID="Git.gitNormalizeURL"></a> @@ -1669,15 +1796,21 @@ </p> <dl> -<dt><i>url</i></dt> -<dd> -url string (string) +<dt><i>url</i> (str)</dt> +<dd> +url string </dd> </dl> <dl> <dt>Return:</dt> <dd> -properly normalized url for git (string) +properly normalized url for git +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Git.gitPruneRemote" ID="Git.gitPruneRemote"></a> @@ -1689,13 +1822,13 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>remoteName</i></dt> -<dd> -name of the remote repository (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>remoteName</i> (str)</dt> +<dd> +name of the remote repository </dd> </dl> <a NAME="Git.gitPull" ID="Git.gitPull"></a> @@ -1707,16 +1840,21 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -directory name of the project to be pulled to (string) +<dt><i>name</i> (str)</dt> +<dd> +directory name of the project to be pulled to </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the update contained an add - or delete (boolean) +flag indicating, that the update contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitPush" ID="Git.gitPush"></a> @@ -1728,9 +1866,9 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -directory name of the project to be pushed from (string) +<dt><i>name</i> (str)</dt> +<dd> +directory name of the project to be pushed from </dd> </dl> <a NAME="Git.gitReflogBrowser" ID="Git.gitReflogBrowser"></a> @@ -1742,9 +1880,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitRemoveRemote" ID="Git.gitRemoveRemote"></a> @@ -1756,13 +1894,13 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>remoteName</i></dt> -<dd> -name of the remote repository (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>remoteName</i> (str)</dt> +<dd> +name of the remote repository </dd> </dl> <a NAME="Git.gitRenameRemote" ID="Git.gitRenameRemote"></a> @@ -1774,13 +1912,13 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>remoteName</i></dt> -<dd> -name of the remote repository (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>remoteName</i> (str)</dt> +<dd> +name of the remote repository </dd> </dl> <a NAME="Git.gitShortlog" ID="Git.gitShortlog"></a> @@ -1793,13 +1931,13 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>commit</i></dt> -<dd> -commit to start the log at (strings) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>commit</i> (str)</dt> +<dd> +commit to start the log at </dd> </dl> <a NAME="Git.gitShowBranch" ID="Git.gitShowBranch"></a> @@ -1811,9 +1949,9 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name (string) +<dt><i>name</i> (str)</dt> +<dd> +file/directory name </dd> </dl> <a NAME="Git.gitShowConfig" ID="Git.gitShowConfig"></a> @@ -1825,9 +1963,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitShowPatchesStatistics" ID="Git.gitShowPatchesStatistics"></a> @@ -1839,9 +1977,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -directory name of the project (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +directory name of the project </dd> </dl> <a NAME="Git.gitShowRemote" ID="Git.gitShowRemote"></a> @@ -1853,13 +1991,13 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>remoteName</i></dt> -<dd> -name of the remote repository (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>remoteName</i> (str)</dt> +<dd> +name of the remote repository </dd> </dl> <a NAME="Git.gitShowRemotes" ID="Git.gitShowRemotes"></a> @@ -1871,9 +2009,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitStashApply" ID="Git.gitStashApply"></a> @@ -1885,20 +2023,25 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>stashName</i></dt> -<dd> -name of a stash (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>stashName</i> (str)</dt> +<dd> +name of a stash </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the restore contained an add - or delete (boolean) +flag indicating, that the restore contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitStashBranch" ID="Git.gitStashBranch"></a> @@ -1910,20 +2053,25 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>stashName</i></dt> -<dd> -name of a stash (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>stashName</i> (str)</dt> +<dd> +name of a stash </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the restore contained an add - or delete (boolean) +flag indicating, that the restore contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitStashBrowser" ID="Git.gitStashBrowser"></a> @@ -1935,9 +2083,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitStashClear" ID="Git.gitStashClear"></a> @@ -1949,15 +2097,21 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a successful deletion (boolean) +flag indicating a successful deletion +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitStashDrop" ID="Git.gitStashDrop"></a> @@ -1969,19 +2123,25 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>stashName</i></dt> -<dd> -name of a stash (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>stashName</i> (str)</dt> +<dd> +name of a stash </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a successful deletion (boolean) +flag indicating a successful deletion +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitStashPop" ID="Git.gitStashPop"></a> @@ -1993,20 +2153,25 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>stashName</i></dt> -<dd> -name of a stash (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>stashName</i> (str)</dt> +<dd> +name of a stash </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the restore contained an add - or delete (boolean) +flag indicating, that the restore contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitStashSave" ID="Git.gitStashSave"></a> @@ -2018,16 +2183,21 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the save contained an add - or delete (boolean) +flag indicating, that the save contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitStashShowPatch" ID="Git.gitStashShowPatch"></a> @@ -2039,13 +2209,13 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>stashName</i></dt> -<dd> -name of a stash (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory +</dd> +<dt><i>stashName</i> (str)</dt> +<dd> +name of a stash </dd> </dl> <a NAME="Git.gitStatistics" ID="Git.gitStatistics"></a> @@ -2057,9 +2227,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitSubmoduleAdd" ID="Git.gitSubmoduleAdd"></a> @@ -2206,16 +2376,21 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be reverted (string) +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be reverted </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the update contained an add - or delete (boolean) +flag indicating, that the update contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.gitVerify" ID="Git.gitVerify"></a> @@ -2228,9 +2403,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitVerifyBundle" ID="Git.gitVerifyBundle"></a> @@ -2242,9 +2417,9 @@ </p> <dl> -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +name of the project directory </dd> </dl> <a NAME="Git.gitWorktreeManagement" ID="Git.gitWorktreeManagement"></a> @@ -2270,15 +2445,21 @@ </p> <dl> -<dt><i>command</i></dt> -<dd> -command name (string) +<dt><i>command</i> (str)</dt> +<dd> +command name </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of command options (list of string) +list of command options +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Git.vcsAdd" ID="Git.vcsAdd"></a> @@ -2290,15 +2471,15 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be added (string) -</dd> -<dt><i>isDir</i></dt> -<dd> -flag indicating name is a directory (boolean) -</dd> -<dt><i>noDialog</i></dt> +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be added +</dd> +<dt><i>isDir</i> (bool)</dt> +<dd> +flag indicating name is a directory +</dd> +<dt><i>noDialog</i> (bool)</dt> <dd> flag indicating quiet operations </dd> @@ -2313,13 +2494,13 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be added (string) -</dd> -<dt><i>isDir</i></dt> -<dd> -flag indicating name is a directory (boolean) +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be added +</dd> +<dt><i>isDir</i> (bool)</dt> +<dd> +flag indicating name is a directory </dd> </dl> <a NAME="Git.vcsAddCommitMessage" ID="Git.vcsAddCommitMessage"></a> @@ -2346,10 +2527,9 @@ </p> <dl> -<dt><i>path</i></dt> -<dd> -root directory of the tree to be added (string or list of - strings)) +<dt><i>path</i> (str or list of str)</dt> +<dd> +root directory of the tree to be added </dd> </dl> <a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a> @@ -2367,17 +2547,17 @@ </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> -<dd> -directory to check in (string) -</dd> -<dt><i>shortcut</i></dt> -<dd> -flag indicating a shortcut should be taken (boolean) +<dt><i>dname</i> (str)</dt> +<dd> +directory to check in +</dd> +<dt><i>shortcut</i> (bool)</dt> +<dd> +flag indicating a shortcut should be taken </dd> </dl> <dl> @@ -2387,6 +2567,12 @@ canBeCommited and canBeAdded or None in order to signal an error </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="Git.vcsCheckout" ID="Git.vcsCheckout"></a> <h4>Git.vcsCheckout</h4> <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) @@ -2397,15 +2583,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> -<dd> -project directory to create (string) -</dd> -<dt><i>noDialog</i></dt> +<dt><i>projectDir</i> (str)</dt> +<dd> +project directory to create +</dd> +<dt><i>noDialog</i> (bool)</dt> <dd> flag indicating quiet operations </dd> @@ -2413,7 +2599,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> <a NAME="Git.vcsCleanup" ID="Git.vcsCleanup"></a> @@ -2425,9 +2617,9 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -directory name to be cleaned up (string) +<dt><i>name</i> (str)</dt> +<dd> +directory name to be cleaned up </dd> </dl> <a NAME="Git.vcsClearCommitMessages" ID="Git.vcsClearCommitMessages"></a> @@ -2446,9 +2638,9 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -directory name of the working directory (string) +<dt><i>name</i> (str)</dt> +<dd> +directory name of the working directory </dd> </dl> <a NAME="Git.vcsCommit" ID="Git.vcsCommit"></a> @@ -2461,26 +2653,25 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be committed (string or list of - strings) -</dd> -<dt><i>message</i></dt> -<dd> -message for this operation (string) -</dd> -<dt><i>noDialog</i></dt> -<dd> -flag indicating quiet operations (boolean) -</dd> -<dt><i>commitAll</i></dt> -<dd> -flag indicating to commit all local changes (boolean) -</dd> -<dt><i>amend</i></dt> -<dd> -flag indicating to amend the HEAD commit (boolean) +<dt><i>name</i> (str or list of str)</dt> +<dd> +file/directory name to be committed +</dd> +<dt><i>message</i> (str)</dt> +<dd> +message for this operation +</dd> +<dt><i>noDialog</i> (bool)</dt> +<dd> +flag indicating quiet operations +</dd> +<dt><i>commitAll</i> (bool)</dt> +<dd> +flag indicating to commit all local changes +</dd> +<dt><i>amend</i> (bool)</dt> +<dd> +flag indicating to amend the HEAD commit </dd> </dl> <a NAME="Git.vcsCommitMessages" ID="Git.vcsCommitMessages"></a> @@ -2541,9 +2732,9 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be diffed (string) +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be diffed </dd> </dl> <a NAME="Git.vcsExists" ID="Git.vcsExists"></a> @@ -2556,8 +2747,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the existance (boolean) and an error message - (string) +flag indicating the existance and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) </dd> </dl> <a NAME="Git.vcsExport" ID="Git.vcsExport"></a> @@ -2569,19 +2765,25 @@ </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> -<dd> -project directory to create (string) +<dt><i>projectDir</i> (str)</dt> +<dd> +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> <a NAME="Git.vcsForget" ID="Git.vcsForget"></a> @@ -2611,15 +2813,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) @@ -2631,6 +2833,12 @@ the project browser helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +GitProjectBrowserHelper +</dd> +</dl> <a NAME="Git.vcsGetProjectHelper" ID="Git.vcsGetProjectHelper"></a> <h4>Git.vcsGetProjectHelper</h4> <b>vcsGetProjectHelper</b>(<i>project</i>) @@ -2640,7 +2848,7 @@ </p> <dl> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> @@ -2651,6 +2859,12 @@ the project helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +GitProjectHelper +</dd> +</dl> <a NAME="Git.vcsImport" ID="Git.vcsImport"></a> <h4>Git.vcsImport</h4> <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) @@ -2666,7 +2880,7 @@ </dd> <dt><i>projectDir</i> (str)</dt> <dd> -project directory (string) +project directory </dd> <dt><i>noDialog</i> (bool)</dt> <dd> @@ -2704,19 +2918,25 @@ </p> <dl> -<dt><i>vcsDir</i></dt> -<dd> -name of the VCS directory (string) -</dd> -<dt><i>noDialog</i></dt> -<dd> -flag indicating quiet operations (boolean) +<dt><i>vcsDir</i> (str)</dt> +<dd> +name of the VCS directory +</dd> +<dt><i>noDialog</i> (bool)</dt> +<dd> +flag indicating quiet operations </dd> </dl> <dl> <dt>Return:</dt> <dd> -always TRUE +always True +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a> @@ -2731,9 +2951,9 @@ </p> <dl> -<dt><i>project</i></dt> -<dd> -reference to the project (Project) +<dt><i>project</i> (Project)</dt> +<dd> +reference to the project </dd> </dl> <a NAME="Git.vcsLogBrowser" ID="Git.vcsLogBrowser"></a> @@ -2746,14 +2966,13 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to show the log of (string) -</dd> -<dt><i>isFile</i></dt> +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to show the log of +</dd> +<dt><i>isFile</i> (bool)</dt> <dd> flag indicating log for a file is to be shown - (boolean) </dd> </dl> <a NAME="Git.vcsMerge" ID="Git.vcsMerge"></a> @@ -2765,9 +2984,9 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be merged (string) +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be merged </dd> </dl> <a NAME="Git.vcsMove" ID="Git.vcsMove"></a> @@ -2779,19 +2998,19 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be moved (string) -</dd> -<dt><i>project</i></dt> +<dt><i>name</i> (str)</dt> +<dd> +file/directory name to be moved +</dd> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> -<dt><i>target</i></dt> -<dd> -new name of the file/directory (string) -</dd> -<dt><i>noDialog</i></dt> +<dt><i>target</i> (str)</dt> +<dd> +new name of the file/directory +</dd> +<dt><i>noDialog</i> (bool)</dt> <dd> flag indicating quiet operations </dd> @@ -2799,7 +3018,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating successful operation (boolean) +flag indicating successful operation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.vcsName" ID="Git.vcsName"></a> @@ -2812,7 +3037,13 @@ <dl> <dt>Return:</dt> <dd> -always 'Git' (string) +always 'Git' +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Git.vcsNewProjectOptionsDialog" ID="Git.vcsNewProjectOptionsDialog"></a> @@ -2825,16 +3056,21 @@ </p> <dl> -<dt><i>parent</i></dt> -<dd> -parent widget (QWidget) +<dt><i>parent</i> (QWidget)</dt> +<dd> +parent widget </dd> </dl> <dl> <dt>Return:</dt> <dd> reference to the instantiated options dialog - (GitNewProjectOptionsDialog) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +GitNewProjectOptionsDialog </dd> </dl> <a NAME="Git.vcsOptionsDialog" ID="Git.vcsOptionsDialog"></a> @@ -2846,28 +3082,33 @@ </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> -<dd> -name of the project in the repository (string) -</dd> -<dt><i>editable</i></dt> +<dt><i>archive</i> (str)</dt> +<dd> +name of the project in the repository +</dd> +<dt><i>editable</i> (bool)</dt> <dd> flag indicating that the project name is editable - (boolean) -</dd> -<dt><i>parent</i></dt> -<dd> -parent widget (QWidget) +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +parent widget </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the instantiated options dialog (GitOptionsDialog) +reference to the instantiated options dialog +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +GitOptionsDialog </dd> </dl> <a NAME="Git.vcsRegisteredState" ID="Git.vcsRegisteredState"></a> @@ -2879,15 +3120,21 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -filename to check (string) +<dt><i>name</i> (str)</dt> +<dd> +filename to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -a combination of canBeCommited and canBeAdded +registered state (one of canBeCommited and canBeAdded) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Git.vcsRemove" ID="Git.vcsRemove"></a> @@ -2903,30 +3150,34 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be removed (string or list of - strings)) -</dd> -<dt><i>project</i></dt> -<dd> -flag indicating deletion of a project tree (boolean) - (not needed) -</dd> -<dt><i>noDialog</i></dt> -<dd> -flag indicating quiet operations (boolean) -</dd> -<dt><i>stageOnly</i></dt> +<dt><i>name</i> (str or list of str)</dt> +<dd> +file/directory name to be removed +</dd> +<dt><i>project</i> (bool)</dt> +<dd> +flag indicating deletion of a project tree +</dd> +<dt><i>noDialog</i> (bool)</dt> +<dd> +flag indicating quiet operations +</dd> +<dt><i>stageOnly</i> (bool)</dt> <dd> flag indicating to just remove the file from the - staging area (boolean) + staging area </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating successful operation (boolean) +flag indicating successful operation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.vcsRepositoryInfos" ID="Git.vcsRepositoryInfos"></a> @@ -2938,15 +3189,21 @@ </p> <dl> -<dt><i>ppath</i></dt> -<dd> -local path to get the repository infos (string) +<dt><i>ppath</i> (str)</dt> +<dd> +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> <a NAME="Git.vcsRevert" ID="Git.vcsRevert"></a> @@ -2986,17 +3243,17 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file name to be diffed (string) -</dd> -<dt><i>extended</i></dt> -<dd> -flag indicating the extended variant (boolean) -</dd> -<dt><i>revisions</i></dt> -<dd> -tuple of two revisions (tuple of strings) +<dt><i>name</i> (str)</dt> +<dd> +file name to be diffed +</dd> +<dt><i>extended</i> (bool)</dt> +<dd> +flag indicating the extended variant +</dd> +<dt><i>revisions</i> (tuple of (str, str))</dt> +<dd> +tuple of two revisions </dd> </dl> <dl> @@ -3023,10 +3280,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> file/directory name(s) to show the status of - (string or list of strings) </dd> </dl> <a NAME="Git.vcsSupportCommandOptions" ID="Git.vcsSupportCommandOptions"></a> @@ -3040,7 +3296,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="Git.vcsSwitch" ID="Git.vcsSwitch"></a> @@ -3053,16 +3314,21 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -directory name to be switched (string) +<dt><i>name</i> (str)</dt> +<dd> +directory name to be switched </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the switch contained an add - or delete (boolean) +flag indicating, that the switch contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.vcsTag" ID="Git.vcsTag"></a> @@ -3074,24 +3340,29 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> file/directory name to determine the repo root from - (string) -</dd> -<dt><i>revision</i></dt> -<dd> -revision to set tag for (string) -</dd> -<dt><i>tagName</i></dt> -<dd> -name of the tag (string) +</dd> +<dt><i>revision</i> (str)</dt> +<dd> +revision to set tag for +</dd> +<dt><i>tagName</i> (str)</dt> +<dd> +name of the tag </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a performed tag action (boolean) +flag indicating a performed tag action +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Git.vcsUpdate" ID="Git.vcsUpdate"></a> @@ -3104,25 +3375,29 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -file/directory name to be updated (string or list of - strings) -</dd> -<dt><i>noDialog</i></dt> -<dd> -flag indicating quiet operations (boolean) -</dd> -<dt><i>revision</i></dt> -<dd> -revision to update to (string) +<dt><i>name</i> (str or list of str)</dt> +<dd> +file/directory name to be updated +</dd> +<dt><i>noDialog</i> (bool)</dt> +<dd> +flag indicating quiet operations +</dd> +<dt><i>revision</i> (str)</dt> +<dd> +revision to update to </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the update contained an add - or delete (boolean) +flag indicating, that the update contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.CloseheadExtension.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -119,7 +119,13 @@ <dl> <dt>Return:</dt> <dd> -populated menu (QMenu) +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="CloseheadProjectHelper.menuTitle" ID="CloseheadProjectHelper.menuTitle"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ConfigurationPage.MercurialPage.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ConfigurationPage.MercurialPage.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,7 +90,7 @@ </p> <dl> -<dt><i>plugin</i></dt> +<dt><i>plugin</i> (Hg)</dt> <dd> reference to the plugin object </dd>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.HgGpgSignaturesDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.HgGpgSignaturesDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -130,13 +130,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgGpgSignaturesDialog.__filterSignatures" ID="HgGpgSignaturesDialog.__filterSignatures"></a> @@ -163,17 +163,17 @@ </p> <dl> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision number (string) +revision number </dd> -<dt><i>changeset</i></dt> +<dt><i>changeset</i> (str)</dt> <dd> -changeset of the bookmark (string) +changeset of the bookmark </dd> -<dt><i>signature</i></dt> +<dt><i>signature</i> (str)</dt> <dd> -signature of the changeset (string) +signature of the changeset </dd> </dl> <a NAME="HgGpgSignaturesDialog.__processOutputLine" ID="HgGpgSignaturesDialog.__processOutputLine"></a> @@ -185,9 +185,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -output line to be processed (string) +output line to be processed </dd> </dl> <a NAME="HgGpgSignaturesDialog.__resizeColumns" ID="HgGpgSignaturesDialog.__resizeColumns"></a> @@ -213,9 +213,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgGpgSignaturesDialog.closeEvent" ID="HgGpgSignaturesDialog.closeEvent"></a> @@ -227,9 +227,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgGpgSignaturesDialog.on_buttonBox_clicked" ID="HgGpgSignaturesDialog.on_buttonBox_clicked"></a> @@ -241,9 +241,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgGpgSignaturesDialog.on_categoryCombo_activated" ID="HgGpgSignaturesDialog.on_categoryCombo_activated"></a> @@ -269,9 +269,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -filter expression (string) +filter expression </dd> </dl> <a NAME="HgGpgSignaturesDialog.on_signaturesList_itemSelectionChanged" ID="HgGpgSignaturesDialog.on_signaturesList_itemSelectionChanged"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -133,15 +133,21 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> -reference to the main menu (QMenu) +reference to the main menu </dd> </dl> <dl> <dt>Return:</dt> <dd> -populated menu (QMenu) +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="GpgProjectHelper.menuTitle" ID="GpgProjectHelper.menuTitle"></a> @@ -154,7 +160,13 @@ <dl> <dt>Return:</dt> <dd> -title of the menu (string) +title of the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.gpg.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.gpg.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,7 +90,7 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the Mercurial vcs object </dd> @@ -125,9 +125,9 @@ </p> <dl> -<dt><i>rev</i></dt> +<dt><i>rev</i> (str)</dt> <dd> -revision to check (string) +revision to check </dd> </dl> <a NAME="Gpg.shutdown" ID="Gpg.shutdown"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgAddSubrepositoryDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgAddSubrepositoryDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -94,13 +94,13 @@ </p> <dl> -<dt><i>projectPath</i></dt> +<dt><i>projectPath</i> (str)</dt> <dd> -project directory name (string) +project directory name </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgAddSubrepositoryDialog.__updateOk" ID="HgAddSubrepositoryDialog.__updateOk"></a> @@ -121,8 +121,13 @@ <dt>Return:</dt> <dd> tuple containing the relative path within the project, the - sub-repository type and the sub-repository URL (string, string, - string) + sub-repository type and the sub-repository URL +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, str) </dd> </dl> <a NAME="HgAddSubrepositoryDialog.on_pathPicker_pathSelected" ID="HgAddSubrepositoryDialog.on_pathPicker_pathSelected"></a> @@ -148,9 +153,9 @@ </p> <dl> -<dt><i>p0</i></dt> +<dt><i>p0</i> (str)</dt> <dd> -text of the path edit (string) +text of the path edit </dd> </dl> <a NAME="HgAddSubrepositoryDialog.on_urlEdit_textChanged" ID="HgAddSubrepositoryDialog.on_urlEdit_textChanged"></a> @@ -162,9 +167,9 @@ </p> <dl> -<dt><i>p0</i></dt> +<dt><i>p0</i> (str)</dt> <dd> -text of the URL edit (string) +text of the URL edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -110,13 +110,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgAnnotateDialog.__buildSkipList" ID="HgAnnotateDialog.__buildSkipList"></a> @@ -162,29 +162,29 @@ </p> <dl> -<dt><i>marker</i></dt> +<dt><i>marker</i> (str)</dt> <dd> -marker character for skipped revisions (string) +marker character for skipped revisions </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision string (string) +revision string </dd> -<dt><i>changeset</i></dt> +<dt><i>changeset</i> (str)</dt> <dd> -changeset string (string) +changeset string </dd> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author of the change (string) +author of the change </dd> -<dt><i>date</i></dt> +<dt><i>date</i> (str)</dt> <dd> -date of the change (string) +date of the change </dd> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text of the change (string) +text of the change </dd> </dl> <a NAME="HgAnnotateDialog.__processOutputLine" ID="HgAnnotateDialog.__processOutputLine"></a> @@ -196,9 +196,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -output line to be processed (string) +output line to be processed </dd> </dl> <a NAME="HgAnnotateDialog.__resizeColumns" ID="HgAnnotateDialog.__resizeColumns"></a> @@ -217,9 +217,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgAnnotateDialog.closeEvent" ID="HgAnnotateDialog.closeEvent"></a> @@ -231,9 +231,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgAnnotateDialog.on_buttonBox_clicked" ID="HgAnnotateDialog.on_buttonBox_clicked"></a> @@ -245,9 +245,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgAnnotateDialog.start" ID="HgAnnotateDialog.start"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgArchiveDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgArchiveDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -86,13 +86,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the Mercurial object (Hg) </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgArchiveDialog.getData" ID="HgArchiveDialog.getData"></a> @@ -105,9 +105,14 @@ <dl> <dt>Return:</dt> <dd> -tuple giving the archive name (string), the archive type - (string), the directory prefix 8string) and a flag indicating - to recurse into subrepositories (boolean) +tuple giving the archive name, the archive type, the directory prefix + and a flag indicating to recurse into subrepositories +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, str, bool) </dd> </dl> <a NAME="HgArchiveDialog.on_archivePicker_textChanged" ID="HgArchiveDialog.on_archivePicker_textChanged"></a> @@ -119,9 +124,9 @@ </p> <dl> -<dt><i>archive</i></dt> +<dt><i>archive</i> (str)</dt> <dd> -name of the archive (string) +name of the archive </dd> </dl> <a NAME="HgArchiveDialog.on_typeComboBox_activated" ID="HgArchiveDialog.on_typeComboBox_activated"></a> @@ -133,9 +138,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -index of the selected type (integer) +index of the selected type </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarkRenameDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarkRenameDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,13 +90,13 @@ </p> <dl> -<dt><i>bookmarksList</i></dt> +<dt><i>bookmarksList</i> (list of str)</dt> <dd> -list of bookmarks (list of strings) +list of bookmarks </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgBookmarkRenameDialog.__updateUI" ID="HgBookmarkRenameDialog.__updateUI"></a> @@ -117,7 +117,12 @@ <dt>Return:</dt> <dd> tuple naming the old and new bookmark names - (string, string) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) </dd> </dl> <a NAME="HgBookmarkRenameDialog.on_bookmarkCombo_editTextChanged" ID="HgBookmarkRenameDialog.on_bookmarkCombo_editTextChanged"></a> @@ -129,9 +134,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -name of the selected bookmark (string) +name of the selected bookmark </dd> </dl> <a NAME="HgBookmarkRenameDialog.on_nameEdit_textChanged" ID="HgBookmarkRenameDialog.on_nameEdit_textChanged"></a> @@ -143,9 +148,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -111,18 +111,18 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>mode</i></dt> +<dt><i>mode</i> (int)</dt> <dd> mode of the dialog (HgBookmarksInOutDialog.INCOMING, HgBookmarksInOutDialog.OUTGOING) </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <dl> @@ -149,13 +149,13 @@ </p> <dl> -<dt><i>changeset</i></dt> +<dt><i>changeset</i> (str)</dt> <dd> -changeset of the bookmark (string) +changeset of the bookmark </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the bookmark (string) +name of the bookmark </dd> </dl> <a NAME="HgBookmarksInOutDialog.__processOutputLine" ID="HgBookmarksInOutDialog.__processOutputLine"></a> @@ -167,9 +167,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -output line to be processed (string) +output line to be processed </dd> </dl> <a NAME="HgBookmarksInOutDialog.__resizeColumns" ID="HgBookmarksInOutDialog.__resizeColumns"></a> @@ -195,9 +195,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgBookmarksInOutDialog.closeEvent" ID="HgBookmarksInOutDialog.closeEvent"></a> @@ -209,9 +209,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgBookmarksInOutDialog.on_buttonBox_clicked" ID="HgBookmarksInOutDialog.on_buttonBox_clicked"></a> @@ -223,9 +223,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgBookmarksInOutDialog.start" ID="HgBookmarksInOutDialog.start"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksListDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksListDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -146,13 +146,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgBookmarksListDialog.__deleteBookmark" ID="HgBookmarksListDialog.__deleteBookmark"></a> @@ -179,21 +179,21 @@ </p> <dl> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision of the bookmark (string) +revision of the bookmark </dd> -<dt><i>changeset</i></dt> +<dt><i>changeset</i> (str)</dt> <dd> -changeset of the bookmark (string) +changeset of the bookmark </dd> -<dt><i>status</i></dt> +<dt><i>status</i> (str)</dt> <dd> -of the bookmark (string) +of the bookmark </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the bookmark (string) +name of the bookmark </dd> </dl> <a NAME="HgBookmarksListDialog.__processOutputLine" ID="HgBookmarksListDialog.__processOutputLine"></a> @@ -205,9 +205,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -output line to be processed (string) +output line to be processed </dd> </dl> <a NAME="HgBookmarksListDialog.__pullBookmark" ID="HgBookmarksListDialog.__pullBookmark"></a> @@ -268,9 +268,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgBookmarksListDialog.__switchTo" ID="HgBookmarksListDialog.__switchTo"></a> @@ -289,9 +289,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested" ID="HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested"></a> @@ -317,9 +317,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgBookmarksListDialog.on_refreshButton_clicked" ID="HgBookmarksListDialog.on_refreshButton_clicked"></a> @@ -338,10 +338,9 @@ </p> <dl> -<dt><i>bookmarksList</i></dt> +<dt><i>bookmarksList</i> (list of str)</dt> <dd> reference to string list receiving the bookmarks - (list of strings) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBranchInputDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBranchInputDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -82,14 +82,13 @@ </p> <dl> -<dt><i>branches</i></dt> +<dt><i>branches</i> (list of str)</dt> <dd> branch names to populate the branch list with - (list of string) </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgBranchInputDialog.getData" ID="HgBranchInputDialog.getData"></a> @@ -121,9 +120,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -contents of the branch combo box (string) +contents of the branch combo box </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBundleDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBundleDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -153,8 +153,13 @@ <dt>Return:</dt> <dd> tuple naming the revisions, base revisions, the compression - type and a flag indicating to bundle all changesets (string, - string, boolean) + type and a flag indicating to bundle all changesets +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, bool) </dd> </dl> <a NAME="HgBundleDialog.on_bookmarkButton_toggled" ID="HgBundleDialog.on_bookmarkButton_toggled"></a> @@ -166,9 +171,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="HgBundleDialog.on_bookmarkCombo_editTextChanged" ID="HgBundleDialog.on_bookmarkCombo_editTextChanged"></a> @@ -180,9 +185,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="HgBundleDialog.on_branchButton_toggled" ID="HgBundleDialog.on_branchButton_toggled"></a> @@ -194,9 +199,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="HgBundleDialog.on_branchCombo_editTextChanged" ID="HgBundleDialog.on_branchCombo_editTextChanged"></a> @@ -208,9 +213,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="HgBundleDialog.on_multipleButton_toggled" ID="HgBundleDialog.on_multipleButton_toggled"></a> @@ -222,9 +227,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="HgBundleDialog.on_multipleEdit_textChanged" ID="HgBundleDialog.on_multipleEdit_textChanged"></a> @@ -243,9 +248,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the button (boolean) +state of the button </dd> </dl> <a NAME="HgBundleDialog.on_tagCombo_editTextChanged" ID="HgBundleDialog.on_tagCombo_editTextChanged"></a> @@ -257,9 +262,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgClientPromptDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgClientPromptDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,17 +90,17 @@ </p> <dl> -<dt><i>size</i></dt> +<dt><i>size</i> (int)</dt> <dd> -maximum length of the requested input (integer) +maximum length of the requested input </dd> -<dt><i>message</i></dt> +<dt><i>message</i> (str)</dt> <dd> -message sent by the server (string) +message sent by the server </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgClientPromptDialog.getInput" ID="HgClientPromptDialog.getInput"></a> @@ -113,7 +113,13 @@ <dl> <dt>Return:</dt> <dd> -user input (string) +user input +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="HgClientPromptDialog.isPassword" ID="HgClientPromptDialog.isPassword"></a> @@ -144,9 +150,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text entered by the user (string) +text entered by the user </dd> </dl> <a NAME="HgClientPromptDialog.on_passwordCheckBox_toggled" ID="HgClientPromptDialog.on_passwordCheckBox_toggled"></a> @@ -158,9 +164,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgCommandDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgCommandDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -87,17 +87,17 @@ </p> <dl> -<dt><i>argvList</i></dt> +<dt><i>argvList</i> (list of str)</dt> <dd> -history list of commandline arguments (list of strings) +history list of commandline arguments </dd> -<dt><i>ppath</i></dt> +<dt><i>ppath</i> (str)</dt> <dd> -pathname of the project directory (string) +pathname of the project directory </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of this dialog (QWidget) +parent widget of this dialog </dd> </dl> <a NAME="HgCommandDialog.getData" ID="HgCommandDialog.getData"></a> @@ -110,7 +110,13 @@ <dl> <dt>Return:</dt> <dd> -commandline parameters (string) +commandline parameters +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="HgCommandDialog.on_commandCombo_editTextChanged" ID="HgCommandDialog.on_commandCombo_editTextChanged"></a> @@ -122,7 +128,7 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> ignored </dd>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgCommitDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -110,25 +110,25 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -initial message (string) +initial message </dd> -<dt><i>mq</i></dt> +<dt><i>mq</i> (bool)</dt> <dd> -flag indicating a queue commit (boolean) +flag indicating a queue commit </dd> -<dt><i>merge</i></dt> +<dt><i>merge</i> (bool)</dt> <dd> -flag indicating a merge commit (boolean) +flag indicating a merge commit </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgCommitDialog.getCommitData" ID="HgCommitDialog.getCommitData"></a> @@ -168,9 +168,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgCommitDialog.on_buttonBox_rejected" ID="HgCommitDialog.on_buttonBox_rejected"></a> @@ -203,9 +203,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QShowEvent)</dt> <dd> -the event (QShowEvent) +the event </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgConflictsListDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgConflictsListDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -148,13 +148,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgConflictsListDialog.__finish" ID="HgConflictsListDialog.__finish"></a> @@ -174,13 +174,13 @@ </p> <dl> -<dt><i>status</i></dt> +<dt><i>status</i> (str)</dt> <dd> -status of the file (string) +status of the file </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the file (string) +name of the file </dd> </dl> <a NAME="HgConflictsListDialog.__getEntries" ID="HgConflictsListDialog.__getEntries"></a> @@ -199,9 +199,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -output line to be processed (string) +output line to be processed </dd> </dl> <a NAME="HgConflictsListDialog.__resizeColumns" ID="HgConflictsListDialog.__resizeColumns"></a> @@ -227,9 +227,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgConflictsListDialog.closeEvent" ID="HgConflictsListDialog.closeEvent"></a> @@ -241,9 +241,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgConflictsListDialog.on_buttonBox_clicked" ID="HgConflictsListDialog.on_buttonBox_clicked"></a> @@ -255,9 +255,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgConflictsListDialog.on_conflictsList_itemDoubleClicked" ID="HgConflictsListDialog.on_conflictsList_itemDoubleClicked"></a> @@ -269,13 +269,13 @@ </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QTreeWidgetItem)</dt> <dd> -reference to the double clicked item (QTreeWidgetItem) +reference to the double clicked item </dd> -<dt><i>column</i></dt> +<dt><i>column</i> (int)</dt> <dd> -column that was double clicked (integer) +column that was double clicked </dd> </dl> <a NAME="HgConflictsListDialog.on_conflictsList_itemSelectionChanged" ID="HgConflictsListDialog.on_conflictsList_itemSelectionChanged"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgCopyDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgCopyDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -83,17 +83,17 @@ </p> <dl> -<dt><i>source</i></dt> +<dt><i>source</i> (str)</dt> <dd> -name of the source file/directory (string) +name of the source file/directory </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> -<dt><i>move</i></dt> +<dt><i>move</i> (bool)</dt> <dd> -flag indicating a move operation (boolean) +flag indicating a move operation </dd> </dl> <a NAME="HgCopyDialog.getData" ID="HgCopyDialog.getData"></a> @@ -107,7 +107,13 @@ <dt>Return:</dt> <dd> the target name (string) and a flag indicating - the operation should be enforced (boolean) + the operation should be enforced +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="HgCopyDialog.on_targetPicker_textChanged" ID="HgCopyDialog.on_targetPicker_textChanged"></a> @@ -119,9 +125,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -contents of the target edit (string) +contents of the target edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -115,22 +115,22 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text to be shown by the label (string) +text to be shown by the label </dd> -<dt><i>hg</i></dt> +<dt><i>hg</i> (Hg)</dt> <dd> -reference to the Mercurial interface object (Hg) +reference to the Mercurial interface object </dd> -<dt><i>useClient</i></dt> +<dt><i>useClient</i> (bool)</dt> <dd> flag indicating to use the command server client - if possible (boolean) + if possible </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgDialog.__finish" ID="HgDialog.__finish"></a> @@ -181,9 +181,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgDialog.__showOutput" ID="HgDialog.__showOutput"></a> @@ -195,9 +195,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -output to be shown (string) +output to be shown </dd> </dl> <a NAME="HgDialog.hasAddOrDelete" ID="HgDialog.hasAddOrDelete"></a> @@ -210,7 +210,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of an add or delete (boolean) +flag indicating the presence of an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="HgDialog.normalExit" ID="HgDialog.normalExit"></a> @@ -223,7 +229,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating normal process termination (boolean) +flag indicating normal process termination +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="HgDialog.normalExitWithoutErrors" ID="HgDialog.normalExitWithoutErrors"></a> @@ -237,7 +249,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating normal process termination (boolean) +flag indicating normal process termination +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="HgDialog.on_buttonBox_clicked" ID="HgDialog.on_buttonBox_clicked"></a> @@ -249,9 +267,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgDialog.startProcess" ID="HgDialog.startProcess"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -103,13 +103,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgDiffDialog.__generatorFinished" ID="HgDiffDialog.__generatorFinished"></a> @@ -128,9 +128,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgDiffDialog.on_buttonBox_clicked" ID="HgDiffDialog.on_buttonBox_clicked"></a> @@ -142,9 +142,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgDiffDialog.on_filesCombo_activated" ID="HgDiffDialog.on_filesCombo_activated"></a> @@ -156,9 +156,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -activated row (integer) +activated row </dd> </dl> <a NAME="HgDiffDialog.on_refreshButton_clicked" ID="HgDiffDialog.on_refreshButton_clicked"></a> @@ -188,26 +188,25 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to be diffed (string) +filename to be diffed </dd> -<dt><i>versions</i></dt> +<dt><i>versions</i> (list of [str, str])</dt> <dd> -list of versions to be diffed (list of up to - 2 strings or None) +list of versions to be diffed or None </dd> -<dt><i>bundle</i></dt> +<dt><i>bundle</i> (str)</dt> <dd> -name of a bundle file (string) +name of a bundle file </dd> -<dt><i>qdiff</i></dt> +<dt><i>qdiff</i> (bool)</dt> <dd> -flag indicating qdiff command shall be used (boolean) +flag indicating qdiff command shall be used </dd> -<dt><i>refreshable</i></dt> +<dt><i>refreshable</i> (bool)</dt> <dd> -flag indicating a refreshable diff (boolean) +flag indicating a refreshable diff </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.html Sat Dec 23 15:40:23 2023 +0100 @@ -110,13 +110,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgDiffGenerator.__extractFileName" ID="HgDiffGenerator.__extractFileName"></a> @@ -128,15 +128,21 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -line to be processed (string) +line to be processed </dd> </dl> <dl> <dt>Return:</dt> <dd> -extracted file name (string) +extracted file name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="HgDiffGenerator.__finish" ID="HgDiffGenerator.__finish"></a> @@ -156,15 +162,21 @@ </p> <dl> -<dt><i>version</i></dt> +<dt><i>version</i> (int or str)</dt> <dd> -revision (integer or string) +revision </dd> </dl> <dl> <dt>Return:</dt> <dd> -version argument (string) +version argument +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="HgDiffGenerator.__processFileLine" ID="HgDiffGenerator.__processFileLine"></a> @@ -195,9 +207,14 @@ <dl> <dt>Return:</dt> <dd> -tuple of lists of string containing lines of the diff, the - list of errors and a list of tuples of filenames and the line - into the diff output. +tuple containing a list of lines of the diff, a list of errors + and a list of tuples of filenames and the line into the diff output +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, list of str, list of tuple of (str, int)) </dd> </dl> <a NAME="HgDiffGenerator.start" ID="HgDiffGenerator.start"></a> @@ -209,29 +226,33 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to be diffed (string) +filename to be diffed </dd> -<dt><i>versions</i></dt> +<dt><i>versions</i> (list of up to 2 str or None)</dt> <dd> -list of versions to be diffed (list of up to - 2 strings or None) +list of versions to be diffed </dd> -<dt><i>bundle</i></dt> +<dt><i>bundle</i> (str)</dt> <dd> -name of a bundle file (string) +name of a bundle file </dd> -<dt><i>qdiff</i></dt> +<dt><i>qdiff</i> (bool)</dt> <dd> -flag indicating qdiff command shall be used (boolean) +flag indicating qdiff command shall be used </dd> </dl> <dl> <dt>Return:</dt> <dd> flag indicating a successful start of the diff command - (boolean) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="HgDiffGenerator.stopProcess" ID="HgDiffGenerator.stopProcess"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffHighlighter.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffHighlighter.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,9 +78,9 @@ </p> <dl> -<dt><i>doc</i></dt> +<dt><i>doc</i> (QTextDocument)</dt> <dd> -reference to the text document (QTextDocument) +reference to the text document </dd> </dl> <a NAME="HgDiffHighlighter.generateRules" ID="HgDiffHighlighter.generateRules"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExportDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -154,9 +154,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -contents of the line edit (string) +contents of the line edit </dd> </dl> <a NAME="HgExportDialog.on_patternEdit_textChanged" ID="HgExportDialog.on_patternEdit_textChanged"></a> @@ -168,9 +168,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -contents of the line edit (string) +contents of the line edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtension.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtension.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,7 +78,7 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the Mercurial vcs object </dd>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -96,15 +96,15 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>browserObject</i></dt> +<dt><i>browserObject</i> (ProjectBaseBrowser)</dt> <dd> reference to the project browser object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</i> (Project)</dt> <dd> reference to the project object </dd> @@ -118,10 +118,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -filename or directoryname of the item to be updated - (string) +filename or directory name of the item to be updated </dd> </dl> <a NAME="HgExtensionProjectBrowserHelper.initMenus" ID="HgExtensionProjectBrowserHelper.initMenus"></a> @@ -137,9 +136,14 @@ <dl> <dt>Return:</dt> <dd> -dictionary of populated menu (dict of QMenu). The dict - must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' - and 'dirMultiMenu'. +dictionary of populated menu. The dict must have the keys + 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict of QMenu </dd> </dl> <dl> @@ -163,7 +167,13 @@ <dl> <dt>Return:</dt> <dd> -title of the menu (string) +title of the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <dl> @@ -187,16 +197,15 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> -menu key (string, one of 'mainMenu', 'multiMenu', +menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' or 'dirMultiMenu') </dd> -<dt><i>controlled</i></dt> +<dt><i>controlled</i> (bool)</dt> <dd> flag indicating to prepare the menu for a version controlled entry or a non-version controlled entry - (boolean) </dd> </dl> <dl>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -111,7 +111,13 @@ <dl> <dt>Return:</dt> <dd> -list of all actions (list of EricAction) +list of all actions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of EricAction </dd> </dl> <a NAME="HgExtensionProjectHelper.initActions" ID="HgExtensionProjectHelper.initActions"></a> @@ -144,15 +150,21 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> -reference to the main menu (QMenu) +reference to the main menu </dd> </dl> <dl> <dt>Return:</dt> <dd> -populated menu (QMenu) +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <dl> @@ -176,7 +188,13 @@ <dl> <dt>Return:</dt> <dd> -title of the menu (string) +title of the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <dl> @@ -196,11 +214,11 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</i> (Project)</dt> <dd> reference to the project object </dd>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgGraftDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgGraftDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -174,9 +174,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="HgGraftDialog.on_userGroup_toggled" ID="HgGraftDialog.on_userGroup_toggled"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgImportDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgImportDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -133,9 +133,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -contents of the line edit (string) +contents of the line edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -417,7 +417,13 @@ <dl> <dt>Return:</dt> <dd> -selected action mode (string, one of filter or find) +selected action mode (one of 'filter' or 'find') +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="HgLogBrowserDialog.__addFinishCallback" ID="HgLogBrowserDialog.__addFinishCallback"></a> @@ -461,15 +467,21 @@ </p> <dl> -<dt><i>branchName</i></dt> +<dt><i>branchName</i> (str)</dt> <dd> -name of the branch (string) +name of the branch </dd> </dl> <dl> <dt>Return:</dt> <dd> -name of the color to use (string) +name of the color to use +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="HgLogBrowserDialog.__bundleActTriggered" ID="HgLogBrowserDialog.__bundleActTriggered"></a> @@ -502,13 +514,13 @@ </p> <dl> -<dt><i>backwards</i></dt> +<dt><i>backwards</i> (bool)</dt> <dd> -flag indicating to search backwards (boolean) +flag indicating to search backwards </dd> -<dt><i>interactive</i></dt> +<dt><i>interactive</i> (bool)</dt> <dd> -flag indicating an interactive search (boolean) +flag indicating an interactive search </dd> </dl> <a NAME="HgLogBrowserDialog.__finish" ID="HgLogBrowserDialog.__finish"></a> @@ -569,13 +581,13 @@ </p> <dl> -<dt><i>rev</i></dt> +<dt><i>rev</i> (int)</dt> <dd> -revision to calculate edge info for (integer) +revision to calculate edge info for </dd> -<dt><i>parents</i></dt> +<dt><i>parents</i> (list of int)</dt> <dd> -list of parent revisions (list of integers) +list of parent revisions </dd> </dl> <dl> @@ -584,7 +596,12 @@ tuple containing the column and color index for the given node and a list of tuples indicating the edges between the given node and its parents - (integer, integer, [(integer, integer, integer), ...]) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int, [(int, int, int), ...]) </dd> </dl> <a NAME="HgLogBrowserDialog.__generateIcon" ID="HgLogBrowserDialog.__generateIcon"></a> @@ -768,13 +785,13 @@ </p> <dl> -<dt><i>startRev</i></dt> +<dt><i>startRev</i> (int or str)</dt> <dd> -revision number to start from (integer, string) +revision number to start from </dd> -<dt><i>noEntries</i></dt> +<dt><i>noEntries</i> (int)</dt> <dd> -number of entries to get (0 = default) (int) +number of entries to get (0 = default) </dd> </dl> <a NAME="HgLogBrowserDialog.__getParents" ID="HgLogBrowserDialog.__getParents"></a> @@ -787,15 +804,21 @@ </p> <dl> -<dt><i>rev</i></dt> +<dt><i>rev</i> (str)</dt> <dd> -revision number to get parents for (string) +revision number to get parents for </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of parent revisions (list of integers) +list of parent revisions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of int </dd> </dl> <a NAME="HgLogBrowserDialog.__getRevisionOfTag" ID="HgLogBrowserDialog.__getRevisionOfTag"></a> @@ -890,15 +913,21 @@ </p> <dl> -<dt><i>filename</i></dt> +<dt><i>filename</i> (str)</dt> <dd> -file name to be processed (string) +file name to be processed </dd> </dl> <dl> <dt>Return:</dt> <dd> -processed file name (string) +processed file name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="HgLogBrowserDialog.__phaseActTriggered" ID="HgLogBrowserDialog.__phaseActTriggered"></a> @@ -919,7 +948,13 @@ <dt>Return:</dt> <dd> tuple of field index, search expression and flag indicating - that the field index is a data role (integer, string, boolean) + that the field index is a data role +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, str, bool) </dd> </dl> <a NAME="HgLogBrowserDialog.__processBuffer" ID="HgLogBrowserDialog.__processBuffer"></a> @@ -1046,9 +1081,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgLogBrowserDialog.__stripActTriggered" ID="HgLogBrowserDialog.__stripActTriggered"></a> @@ -1129,9 +1164,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgLogBrowserDialog.col2x" ID="HgLogBrowserDialog.col2x"></a> @@ -1143,13 +1178,13 @@ </p> <dl> -<dt><i>col</i></dt> +<dt><i>col</i> (int)</dt> <dd> -column number (integer) +column number </dd> -<dt><i>radius</i></dt> +<dt><i>radius</i> (int)</dt> <dd> -radius of the indicator circle (integer) +radius of the indicator circle </dd> </dl> <a NAME="HgLogBrowserDialog.on_branchCombo_activated" ID="HgLogBrowserDialog.on_branchCombo_activated"></a> @@ -1175,9 +1210,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgLogBrowserDialog.on_diffSelectLabel_linkActivated" ID="HgLogBrowserDialog.on_diffSelectLabel_linkActivated"></a> @@ -1224,13 +1259,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QTreeWidgetItem)</dt> <dd> -reference to the new current item (QTreeWidgetItem) +reference to the new current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QTreeWidgetItem)</dt> <dd> -reference to the old current item (QTreeWidgetItem) +reference to the old current item </dd> </dl> <a NAME="HgLogBrowserDialog.on_findNextButton_clicked" ID="HgLogBrowserDialog.on_findNextButton_clicked"></a> @@ -1256,9 +1291,9 @@ </p> <dl> -<dt><i>date</i></dt> +<dt><i>date</i> (QDate)</dt> <dd> -new date (QDate) +new date </dd> </dl> <a NAME="HgLogBrowserDialog.on_logTree_currentItemChanged" ID="HgLogBrowserDialog.on_logTree_currentItemChanged"></a> @@ -1270,13 +1305,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QTreeWidgetItem)</dt> <dd> -reference to the new current item (QTreeWidgetItem) +reference to the new current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QTreeWidgetItem)</dt> <dd> -reference to the old current item (QTreeWidgetItem) +reference to the old current item </dd> </dl> <a NAME="HgLogBrowserDialog.on_logTree_itemSelectionChanged" ID="HgLogBrowserDialog.on_logTree_itemSelectionChanged"></a> @@ -1295,9 +1330,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -index of the selected entry (integer) +index of the selected entry </dd> </dl> <a NAME="HgLogBrowserDialog.on_nextButton_clicked" ID="HgLogBrowserDialog.on_nextButton_clicked"></a> @@ -1338,9 +1373,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -filter expression (string) +filter expression </dd> </dl> <a NAME="HgLogBrowserDialog.on_saveLabel_linkActivated" ID="HgLogBrowserDialog.on_saveLabel_linkActivated"></a> @@ -1380,9 +1415,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -flag indicating the state of the check box (boolean) +flag indicating the state of the check box </dd> </dl> <a NAME="HgLogBrowserDialog.on_toDate_dateChanged" ID="HgLogBrowserDialog.on_toDate_dateChanged"></a> @@ -1394,9 +1429,9 @@ </p> <dl> -<dt><i>date</i></dt> +<dt><i>date</i> (QDate)</dt> <dd> -new date (QDate) +new date </dd> </dl> <a NAME="HgLogBrowserDialog.on_upButton_clicked" ID="HgLogBrowserDialog.on_upButton_clicked"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgNewProjectOptionsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgNewProjectOptionsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -96,13 +96,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the version control object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgNewProjectOptionsDialog.__saveHistory" ID="HgNewProjectOptionsDialog.__saveHistory"></a> @@ -123,8 +123,14 @@ <dl> <dt>Return:</dt> <dd> -a tuple of a string (project directory) and a dictionary - containing the data entered. +tuple containing the project directory and a dictionary + containing the data entered +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, dict) </dd> </dl> <a NAME="HgNewProjectOptionsDialog.on_vcsProjectDirPicker_textChanged" ID="HgNewProjectOptionsDialog.on_vcsProjectDirPicker_textChanged"></a> @@ -136,9 +142,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -name of the project directory (string) +name of the project directory </dd> </dl> <a NAME="HgNewProjectOptionsDialog.on_vcsUrlClearHistoryButton_clicked" ID="HgNewProjectOptionsDialog.on_vcsUrlClearHistoryButton_clicked"></a> @@ -157,9 +163,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -current text of the line edit (string) +current text of the line edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgOptionsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgOptionsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -80,17 +80,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the version control object </dd> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgOptionsDialog.getData" ID="HgOptionsDialog.getData"></a> @@ -106,6 +106,12 @@ a dictionary containing the data entered </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgPhaseDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgPhaseDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -91,9 +91,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgPhaseDialog.__updateOk" ID="HgPhaseDialog.__updateOk"></a> @@ -114,7 +114,13 @@ <dt>Return:</dt> <dd> tuple with list of revisions, phase and a flag indicating - a forced operation (list of strings, string, boolean) + a forced operation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, str, bool) </dd> </dl> <a NAME="HgPhaseDialog.on_phaseCombo_activated" ID="HgPhaseDialog.on_phaseCombo_activated"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgRemoveSubrepositoriesDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgRemoveSubrepositoriesDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -86,13 +86,13 @@ </p> <dl> -<dt><i>subrepositories</i></dt> +<dt><i>subrepositories</i> (list of str)</dt> <dd> -list of sub-repository entries (list of strings) +list of sub-repository entries </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgRemoveSubrepositoriesDialog.getData" ID="HgRemoveSubrepositoriesDialog.getData"></a> @@ -106,8 +106,13 @@ <dt>Return:</dt> <dd> tuple giving the remaining sub-repositories, the removed ones - and a flag indicating to delete the removed ones from disc (list - of strings, list of strings, boolean) + and a flag indicating to delete the removed ones from disc +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, list of str, bool) </dd> </dl> <a NAME="HgRemoveSubrepositoriesDialog.on_removeButton_clicked" ID="HgRemoveSubrepositoriesDialog.on_removeButton_clicked"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgRepoConfigDataDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgRepoConfigDataDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -92,19 +92,17 @@ </p> <dl> -<dt><i>withLargefiles</i></dt> +<dt><i>withLargefiles</i> (bool)</dt> <dd> -flag indicating to configure the largefiles - section (boolean) +flag indicating to configure the largefiles section </dd> -<dt><i>largefilesData</i></dt> +<dt><i>largefilesData</i> (dictdict)</dt> <dd> -dictionary with data for the largefiles - section (dict) +dictionary with data for the largefiles section </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgRepoConfigDataDialog.getData" ID="HgRepoConfigDataDialog.getData"></a> @@ -117,8 +115,13 @@ <dl> <dt>Return:</dt> <dd> -tuple giving the default and default push URLs (tuple of - two strings) +tuple giving the default and default push URLs +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) </dd> </dl> <a NAME="HgRepoConfigDataDialog.getLargefilesData" ID="HgRepoConfigDataDialog.getLargefilesData"></a> @@ -131,8 +134,14 @@ <dl> <dt>Return:</dt> <dd> -tuple with the minimum file size (integer) and file patterns - (list of string). None as value denote to use the default value. +tuple with the minimum file size and file patterns. None as value + denote to use the default value. +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, list of str) </dd> </dl> <a NAME="HgRepoConfigDataDialog.on_defaultPushShowPasswordButton_clicked" ID="HgRepoConfigDataDialog.on_defaultPushShowPasswordButton_clicked"></a> @@ -145,9 +154,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the push button (boolean) +state of the push button </dd> </dl> <a NAME="HgRepoConfigDataDialog.on_defaultShowPasswordButton_clicked" ID="HgRepoConfigDataDialog.on_defaultShowPasswordButton_clicked"></a> @@ -160,9 +169,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the push button (boolean) +state of the push button </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -224,17 +224,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>mq</i></dt> +<dt><i>mq</i> (bool)</dt> <dd> -flag indicating to show a queue repo status (boolean) +flag indicating to show a queue repo status </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgStatusDialog.__abortMerge" ID="HgStatusDialog.__abortMerge"></a> @@ -281,9 +281,9 @@ </p> <dl> -<dt><i>selected</i></dt> +<dt><i>selected</i> (bool)</dt> <dd> -commit selection state to be set (boolean) +commit selection state to be set </dd> </dl> <a NAME="HgStatusDialog.__commitSelectAll" ID="HgStatusDialog.__commitSelectAll"></a> @@ -338,13 +338,13 @@ </p> <dl> -<dt><i>status</i></dt> +<dt><i>status</i> (str)</dt> <dd> -status indicator (string) +status indicator </dd> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -path of the file or directory (string) +path of the file or directory </dd> </dl> <a NAME="HgStatusDialog.__generatorFinished" ID="HgStatusDialog.__generatorFinished"></a> @@ -367,6 +367,12 @@ list of all items, the user has checked </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItems +</dd> +</dl> <a NAME="HgStatusDialog.__getCommitableUnselectedItems" ID="HgStatusDialog.__getCommitableUnselectedItems"></a> <h4>HgStatusDialog.__getCommitableUnselectedItems</h4> <b>__getCommitableUnselectedItems</b>(<i></i>) @@ -381,6 +387,12 @@ list of all items, the user has checked </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItems +</dd> +</dl> <a NAME="HgStatusDialog.__getMissingItems" ID="HgStatusDialog.__getMissingItems"></a> <h4>HgStatusDialog.__getMissingItems</h4> <b>__getMissingItems</b>(<i></i>) @@ -394,6 +406,12 @@ list of all items with a missing status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItems +</dd> +</dl> <a NAME="HgStatusDialog.__getModifiedItems" ID="HgStatusDialog.__getModifiedItems"></a> <h4>HgStatusDialog.__getModifiedItems</h4> <b>__getModifiedItems</b>(<i></i>) @@ -407,6 +425,12 @@ list of all items with a modified status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItems +</dd> +</dl> <a NAME="HgStatusDialog.__getUnversionedItems" ID="HgStatusDialog.__getUnversionedItems"></a> <h4>HgStatusDialog.__getUnversionedItems</h4> <b>__getUnversionedItems</b>(<i></i>) @@ -421,6 +445,12 @@ list of all items with an unversioned status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItems +</dd> +</dl> <a NAME="HgStatusDialog.__initActionsMenu" ID="HgStatusDialog.__initActionsMenu"></a> <h4>HgStatusDialog.__initActionsMenu</h4> <b>__initActionsMenu</b>(<i></i>) @@ -437,9 +467,9 @@ </p> <dl> -<dt><i>mode</i></dt> +<dt><i>mode</i> (str)</dt> <dd> -add mode (string one of 'normal' or 'large') +add mode (one of 'normal' or 'large') </dd> </dl> <a NAME="HgStatusDialog.__processOutputLine" ID="HgStatusDialog.__processOutputLine"></a> @@ -451,9 +481,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -output line to be processed (string) +output line to be processed </dd> </dl> <a NAME="HgStatusDialog.__refreshDiff" ID="HgStatusDialog.__refreshDiff"></a> @@ -514,9 +544,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgStatusDialog.closeEvent" ID="HgStatusDialog.closeEvent"></a> @@ -528,9 +558,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgStatusDialog.on_buttonBox_clicked" ID="HgStatusDialog.on_buttonBox_clicked"></a> @@ -542,9 +572,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgStatusDialog.on_refreshButton_clicked" ID="HgStatusDialog.on_refreshButton_clicked"></a> @@ -591,10 +621,9 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str or list of str)</dt> <dd> filename(s)/directoryname(s) to show the status of - (string or list of strings) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,21 +90,21 @@ </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 (Project) +reference to the project object </dd> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the version control object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QObject)</dt> <dd> -reference to the parent object (QObject) +reference to the parent object </dd> </dl> <a NAME="HgStatusMonitorThread.__initClient" ID="HgStatusMonitorThread.__initClient"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -100,13 +100,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgSummaryDialog.__committed" ID="HgSummaryDialog.__committed"></a> @@ -125,9 +125,9 @@ </p> <dl> -<dt><i>output</i></dt> +<dt><i>output</i> (str)</dt> <dd> -output from the summary command (string) +output from the summary command </dd> </dl> <a NAME="HgSummaryDialog.__showError" ID="HgSummaryDialog.__showError"></a> @@ -139,9 +139,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgSummaryDialog.on_buttonBox_clicked" ID="HgSummaryDialog.on_buttonBox_clicked"></a> @@ -153,9 +153,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgSummaryDialog.on_refreshButton_clicked" ID="HgSummaryDialog.on_refreshButton_clicked"></a> @@ -174,14 +174,14 @@ </p> <dl> -<dt><i>mq</i></dt> +<dt><i>mq</i> (bool)</dt> <dd> -flag indicating to show the queue status as well (boolean) +flag indicating to show the queue status as well </dd> -<dt><i>largefiles</i></dt> +<dt><i>largefiles</i> (bool)</dt> <dd> flag indicating to show the largefiles status as - well (boolean) + well </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgTagBranchListDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgTagBranchListDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -134,13 +134,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgTagBranchListDialog.__closeBranch" ID="HgTagBranchListDialog.__closeBranch"></a> @@ -174,21 +174,21 @@ </p> <dl> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision of the tag/branch (string) +revision of the tag/branch </dd> -<dt><i>changeset</i></dt> +<dt><i>changeset</i> (str)</dt> <dd> -changeset of the tag/branch (string) +changeset of the tag/branch </dd> -<dt><i>status</i></dt> +<dt><i>status</i> (str)</dt> <dd> -of the tag/branch (string) +of the tag/branch </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the tag/branch (string) +name of the tag/branch </dd> </dl> <a NAME="HgTagBranchListDialog.__highlightCurrentBranch" ID="HgTagBranchListDialog.__highlightCurrentBranch"></a> @@ -207,9 +207,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -output line to be processed (string) +output line to be processed </dd> </dl> <a NAME="HgTagBranchListDialog.__resizeColumns" ID="HgTagBranchListDialog.__resizeColumns"></a> @@ -235,9 +235,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgTagBranchListDialog.__switchTo" ID="HgTagBranchListDialog.__switchTo"></a> @@ -256,9 +256,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgTagBranchListDialog.on_buttonBox_clicked" ID="HgTagBranchListDialog.on_buttonBox_clicked"></a> @@ -270,9 +270,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgTagBranchListDialog.on_refreshButton_clicked" ID="HgTagBranchListDialog.on_refreshButton_clicked"></a> @@ -305,19 +305,18 @@ </p> <dl> -<dt><i>tags</i></dt> +<dt><i>tags</i> (bool)</dt> <dd> flag indicating a list of tags is requested (False = branches, True = tags) </dd> -<dt><i>tagsList</i></dt> +<dt><i>tagsList</i> (list of str)</dt> <dd> reference to string list receiving the tags - (list of strings) </dd> -<dt><i>allTagsList</i></dt> +<dt><i>allTagsList</i> (list of str)</dt> <dd> -reference to string list all tags (list of strings) +reference to string list all tags </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgTagDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgTagDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -86,21 +86,21 @@ </p> <dl> -<dt><i>taglist</i></dt> +<dt><i>taglist</i> (list of str)</dt> <dd> -list of previously entered tags (list of strings) +list of previously entered tags </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision to set tag for (string) +revision to set tag for </dd> -<dt><i>tagName</i></dt> +<dt><i>tagName</i> (str)</dt> <dd> -name of the tag (string) +name of the tag </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgTagDialog.getParameters" ID="HgTagDialog.getParameters"></a> @@ -132,9 +132,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -index of the selected entrie (integer) +index of the selected entrie </dd> </dl> <a NAME="HgTagDialog.on_tagCombo_editTextChanged" ID="HgTagDialog.on_tagCombo_editTextChanged"></a> @@ -146,9 +146,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -tag name entered in the combo (string) +tag name entered in the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -153,7 +153,13 @@ <dl> <dt>Return:</dt> <dd> -populated menu (QMenu) +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="HisteditProjectHelper.menuTitle" ID="HisteditProjectHelper.menuTitle"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.LfConvertDataDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.LfConvertDataDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -82,17 +82,17 @@ </p> <dl> -<dt><i>currentPath</i></dt> +<dt><i>currentPath</i> (str)</dt> <dd> -directory name of the current project (string) +directory name of the current project </dd> -<dt><i>mode</i></dt> +<dt><i>mode</i> (str)</dt> <dd> -dialog mode (string, one of 'largefiles' or 'normal') +dialog mode (one of 'largefiles' or 'normal') </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="LfConvertDataDialog.getData" ID="LfConvertDataDialog.getData"></a> @@ -105,8 +105,14 @@ <dl> <dt>Return:</dt> <dd> -tuple containing the new project directory name (string), - minimum file size (integer) and file patterns (list of string) +tuple containing the new project directory name, minimum file size + and file patterns +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, int, list of str) </dd> </dl> <a NAME="LfConvertDataDialog.on_newProjectPicker_textChanged" ID="LfConvertDataDialog.on_newProjectPicker_textChanged"></a> @@ -118,9 +124,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -new project directory name (string) +new project directory name </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.LfRevisionsInputDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.LfRevisionsInputDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -82,9 +82,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="LfRevisionsInputDialog.getRevisions" ID="LfRevisionsInputDialog.getRevisions"></a> @@ -97,7 +97,13 @@ <dl> <dt>Return:</dt> <dd> -list of revisions (list of string) +list of revisions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="LfRevisionsInputDialog.on_revisionsEdit_textChanged" ID="LfRevisionsInputDialog.on_revisionsEdit_textChanged"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,15 +90,15 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>browserObject</i></dt> +<dt><i>browserObject</i> (ProjectBaseBrowser)</dt> <dd> reference to the project browser object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</i> (Project)</dt> <dd> reference to the project object </dd> @@ -112,9 +112,9 @@ </p> <dl> -<dt><i>mode</i></dt> +<dt><i>mode</i> (str)</dt> <dd> -add mode (string one of 'normal' or 'large') +add mode (string ne of 'normal' or 'large') </dd> </dl> <a NAME="LargefilesProjectBrowserHelper.initMenus" ID="LargefilesProjectBrowserHelper.initMenus"></a> @@ -130,9 +130,14 @@ <dl> <dt>Return:</dt> <dd> -dictionary of populated menu (dict of QMenu). The dict - must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' - and 'dirMultiMenu'. +dictionary of populated menu. The dict must have the keys + 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict of QMenu </dd> </dl> <a NAME="LargefilesProjectBrowserHelper.menuTitle" ID="LargefilesProjectBrowserHelper.menuTitle"></a> @@ -148,7 +153,13 @@ <dl> <dt>Return:</dt> <dd> -title of the menu (string) +title of the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="LargefilesProjectBrowserHelper.showExtensionMenu" ID="LargefilesProjectBrowserHelper.showExtensionMenu"></a> @@ -160,16 +171,15 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> -menu key (string, one of 'mainMenu', 'multiMenu', - 'backMenu', 'dirMenu' or 'dirMultiMenu') +menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' + or 'dirMultiMenu') </dd> -<dt><i>controlled</i></dt> +<dt><i>controlled</i> (bool)</dt> <dd> flag indicating to prepare the menu for a version controlled entry or a non-version controlled entry - (boolean) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -127,17 +127,16 @@ </p> <dl> -<dt><i>mode</i></dt> +<dt><i>mode</i> (str)</dt> <dd> -verify mode (string; one of 'large', 'lfa' or 'lfc') +verify mode (one of 'large', 'lfa' or 'lfc') </dd> </dl> <dl> <dt>Raises <b>ValueError</b>:</dt> <dd> -raised to indicate a bad value for the - 'mode' parameter. +raised to indicate a bad value for the 'mode' parameter. </dd> </dl> <a NAME="LargefilesProjectHelper.__hgLfconvert" ID="LargefilesProjectHelper.__hgLfconvert"></a> @@ -149,10 +148,9 @@ </p> <dl> -<dt><i>direction</i></dt> +<dt><i>direction</i> (str)</dt> <dd> -direction of the conversion (string; one of - 'largefiles' or 'normal') +direction of the conversion (one of 'largefiles' or 'normal') </dd> </dl> <dl> @@ -179,15 +177,21 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> -reference to the main menu (QMenu) +reference to the main menu </dd> </dl> <dl> <dt>Return:</dt> <dd> -populated menu (QMenu) +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="LargefilesProjectHelper.menuTitle" ID="LargefilesProjectHelper.menuTitle"></a> @@ -200,7 +204,13 @@ <dl> <dt>Return:</dt> <dd> -title of the menu (string) +title of the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="LargefilesProjectHelper.shutdown" ID="LargefilesProjectHelper.shutdown"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.__init__.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.__init__.html Sat Dec 23 15:40:23 2023 +0100 @@ -42,7 +42,13 @@ <dl> <dt>Return:</dt> <dd> -dictionary with default values and parameter as key (dict) +dictionary with default values and parameter as key +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,7 +90,7 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the Mercurial vcs object </dd> @@ -104,13 +104,13 @@ </p> <dl> -<dt><i>names</i></dt> +<dt><i>names</i> (str or list of str)</dt> <dd> -file name(s) to be added (string or list of string) +file name(s) to be added </dd> -<dt><i>mode</i></dt> +<dt><i>mode</i> (str)</dt> <dd> -add mode (string one of 'normal' or 'large') +add mode (one of 'normal' or 'large') </dd> </dl> <a NAME="Largefiles.hgLfPull" ID="Largefiles.hgLfPull"></a> @@ -122,9 +122,9 @@ </p> <dl> -<dt><i>revisions</i></dt> +<dt><i>revisions</i> (list of str)</dt> <dd> -list of revisions to pull (list of string) +list of revisions to pull </dd> </dl> <a NAME="Largefiles.hgLfVerify" ID="Largefiles.hgLfVerify"></a> @@ -136,9 +136,9 @@ </p> <dl> -<dt><i>mode</i></dt> +<dt><i>mode</i> (str)</dt> <dd> -verify mode (string; one of 'large', 'lfa' or 'lfc') +verify mode (one of 'large', 'lfa' or 'lfc') </dd> </dl> <a NAME="Largefiles.hgLfconvert" ID="Largefiles.hgLfconvert"></a> @@ -150,14 +150,13 @@ </p> <dl> -<dt><i>direction</i></dt> +<dt><i>direction</i> (str)</dt> <dd> -direction of the conversion (string, one of - 'largefiles' or 'normal') +direction of the conversion (one of 'largefiles' or 'normal') </dd> -<dt><i>projectFile</i></dt> +<dt><i>projectFile</i> (str)</dt> <dd> -file name of the current project file (string) +file name of the current project file </dd> </dl> <dl>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -178,30 +178,30 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>browserObject</i></dt> +<dt><i>browserObject</i> (ProjectBaseBrowser)</dt> <dd> reference to the project browser object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</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) </dd> -<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="HgProjectBrowserHelper.__HgAnnotate" ID="HgProjectBrowserHelper.__HgAnnotate"></a> @@ -325,20 +325,26 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -menu to add it to (QMenu) +menu to add it to </dd> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> -menu key (string, one of 'mainMenu', 'multiMenu', - 'backMenu', 'dirMenu' or 'dirMultiMenu') +menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' + or 'dirMultiMenu') </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the menu action (QAction) +reference to the menu action +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QAction </dd> </dl> <a NAME="HgProjectBrowserHelper.__showExtensionMenu" ID="HgProjectBrowserHelper.__showExtensionMenu"></a> @@ -350,16 +356,15 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> -menu key (string, one of 'mainMenu', 'multiMenu', - 'backMenu', 'dirMenu' or 'dirMultiMenu') +menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' + or 'dirMultiMenu') </dd> -<dt><i>controlled</i></dt> +<dt><i>controlled</i> (bool)</dt> <dd> flag indicating to show the menu for a version controlled entry or a non-version controlled entry - (boolean) </dd> </dl> <a NAME="HgProjectBrowserHelper.__skipListFileName" ID="HgProjectBrowserHelper.__skipListFileName"></a> @@ -390,7 +395,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -404,7 +409,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -418,7 +423,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -432,7 +437,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -447,7 +452,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -465,11 +470,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -488,11 +493,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -511,13 +516,13 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> -array of standard items that need +list of standard items that need activation/deactivation depending on the overall VCS status </dd> </dl> @@ -535,11 +540,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -378,21 +378,21 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</i> (Project)</dt> <dd> reference to the project object </dd> -<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="HgProjectHelper.__checkActions" ID="HgProjectHelper.__checkActions"></a> @@ -882,7 +882,13 @@ <dl> <dt>Return:</dt> <dd> -list of all actions (list of EricAction) +list of all actions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of EricAction </dd> </dl> <a NAME="HgProjectHelper.getProject" ID="HgProjectHelper.getProject"></a> @@ -895,7 +901,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the project object (Project) +reference to the project object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +Project </dd> </dl> <a NAME="HgProjectHelper.initActions" ID="HgProjectHelper.initActions"></a> @@ -914,9 +926,9 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu to be populated (QMenu) +reference to the menu to be populated </dd> </dl> <a NAME="HgProjectHelper.initToolbar" ID="HgProjectHelper.initToolbar"></a> @@ -928,14 +940,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <a NAME="HgProjectHelper.removeToolbar" ID="HgProjectHelper.removeToolbar"></a> @@ -947,14 +958,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <a NAME="HgProjectHelper.setObjects" ID="HgProjectHelper.setObjects"></a> @@ -966,11 +976,11 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</i> (Project)</dt> <dd> reference to the project object </dd>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.HgPurgeListDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.HgPurgeListDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -74,13 +74,13 @@ </p> <dl> -<dt><i>entries</i></dt> +<dt><i>entries</i> (list of str)</dt> <dd> -list of entries to be shown (list of strings) +list of entries to be shown </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -144,15 +144,21 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> -reference to the main menu (QMenu) +reference to the main menu </dd> </dl> <dl> <dt>Return:</dt> <dd> -populated menu (QMenu) +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="PurgeProjectHelper.menuTitle" ID="PurgeProjectHelper.menuTitle"></a> @@ -165,7 +171,13 @@ <dl> <dt>Return:</dt> <dd> -title of the menu (string) +title of the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,7 +90,7 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the Mercurial vcs object </dd> @@ -146,10 +146,10 @@ </p> <dl> -<dt><i>deleteAll</i></dt> +<dt><i>deleteAll</i> (bool)</dt> <dd> flag indicating to list all files including ignored - ones (boolean) + ones </dd> </dl> <a NAME="Purge.shutdown" ID="Purge.shutdown"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesDefineGuardsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesDefineGuardsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -114,21 +114,21 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>extension</i></dt> +<dt><i>extension</i> (Queues)</dt> <dd> -reference to the extension module (Queues) +reference to the extension module </dd> -<dt><i>patchesList</i></dt> +<dt><i>patchesList</i> (list of str)</dt> <dd> -list of patches (list of strings) +list of patches </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgQueuesDefineGuardsDialog.__applyGuards" ID="HgQueuesDefineGuardsDialog.__applyGuards"></a> @@ -147,15 +147,21 @@ </p> <dl> -<dt><i>guard</i></dt> +<dt><i>guard</i> (str)</dt> <dd> -name of the guard (string) +name of the guard </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the guard item (QListWidgetItem) +reference to the guard item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QListWidgetItem </dd> </dl> <a NAME="HgQueuesDefineGuardsDialog.closeEvent" ID="HgQueuesDefineGuardsDialog.closeEvent"></a> @@ -167,9 +173,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgQueuesDefineGuardsDialog.on_addButton_clicked" ID="HgQueuesDefineGuardsDialog.on_addButton_clicked"></a> @@ -188,9 +194,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged" ID="HgQueuesDefineGuardsDialog.on_guardCombo_editTextChanged"></a> @@ -202,9 +208,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -contents of the guard combo line edit (string) +contents of the guard combo line edit </dd> </dl> <a NAME="HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged" ID="HgQueuesDefineGuardsDialog.on_guardsList_itemSelectionChanged"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesFoldDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesFoldDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -106,13 +106,13 @@ </p> <dl> -<dt><i>patchesList</i></dt> +<dt><i>patchesList</i> (list of str)</dt> <dd> -list of patches to select from (list of strings) +list of patches to select from </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgQueuesFoldDialog.__updateOkButton" ID="HgQueuesFoldDialog.__updateOkButton"></a> @@ -133,7 +133,12 @@ <dt>Return:</dt> <dd> tuple of commit message and list of selected patches - (string, list of strings) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, list of str) </dd> </dl> <a NAME="HgQueuesFoldDialog.on_addButton_clicked" ID="HgQueuesFoldDialog.on_addButton_clicked"></a> @@ -167,14 +172,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QTreeWidgetItem)</dt> <dd> -reference to the new current item (QTreeWidgetItem) +reference to the new current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QTreeWidgetItem)</dt> <dd> reference to the previous current item - (QTreeWidgetItem) </dd> </dl> <a NAME="HgQueuesFoldDialog.on_sourcePatches_currentItemChanged" ID="HgQueuesFoldDialog.on_sourcePatches_currentItemChanged"></a> @@ -186,14 +190,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QTreeWidgetItem)</dt> <dd> -reference to the new current item (QTreeWidgetItem) +reference to the new current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QTreeWidgetItem)</dt> <dd> reference to the previous current item - (QTreeWidgetItem) </dd> </dl> <a NAME="HgQueuesFoldDialog.on_upButton_clicked" ID="HgQueuesFoldDialog.on_upButton_clicked"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesGuardsSelectionDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesGuardsSelectionDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,21 +78,21 @@ </p> <dl> -<dt><i>guards</i></dt> +<dt><i>guards</i> (list of str)</dt> <dd> -list of guards to select from (list of strings) +list of guards to select from </dd> -<dt><i>activeGuards</i></dt> +<dt><i>activeGuards</i> (list of str)</dt> <dd> -list of active guards (list of strings) +list of active guards </dd> -<dt><i>listOnly</i></dt> +<dt><i>listOnly</i> (bool)</dt> <dd> -flag indicating to only list the guards (boolean) +flag indicating to only list the guards </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgQueuesGuardsSelectionDialog.getData" ID="HgQueuesGuardsSelectionDialog.getData"></a> @@ -105,7 +105,13 @@ <dl> <dt>Return:</dt> <dd> -list of selected guards (list of strings) +list of selected guards +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesHeaderDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesHeaderDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -99,13 +99,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgQueuesHeaderDialog.__finish" ID="HgQueuesHeaderDialog.__finish"></a> @@ -125,9 +125,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgQueuesHeaderDialog.__showOutput" ID="HgQueuesHeaderDialog.__showOutput"></a> @@ -139,9 +139,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -output to be shown (string) +output to be shown </dd> </dl> <a NAME="HgQueuesHeaderDialog.closeEvent" ID="HgQueuesHeaderDialog.closeEvent"></a> @@ -153,9 +153,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgQueuesHeaderDialog.on_buttonBox_clicked" ID="HgQueuesHeaderDialog.on_buttonBox_clicked"></a> @@ -167,9 +167,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgQueuesHeaderDialog.start" ID="HgQueuesHeaderDialog.start"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListAllGuardsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListAllGuardsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,13 +78,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the VCS object (Hg) </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgQueuesListAllGuardsDialog.start" ID="HgQueuesListAllGuardsDialog.start"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -123,13 +123,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgQueuesListDialog.__finish" ID="HgQueuesListDialog.__finish"></a> @@ -149,25 +149,25 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -index of the patch (integer, -1 for missing) +index of the patch (-1 for missing) </dd> -<dt><i>status</i></dt> +<dt><i>status</i> (str)</dt> <dd> -status of the patch (string) +status of the patch </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the patch (string) +name of the patch </dd> -<dt><i>summary</i></dt> +<dt><i>summary</i> (str)</dt> <dd> -first line of the patch header (string) +first line of the patch header </dd> -<dt><i>error</i></dt> +<dt><i>error</i> (bool)</dt> <dd> -flag indicating an error entry (boolean) +flag indicating an error entry </dd> </dl> <a NAME="HgQueuesListDialog.__getSeries" ID="HgQueuesListDialog.__getSeries"></a> @@ -180,10 +180,10 @@ </p> <dl> -<dt><i>missing</i></dt> +<dt><i>missing</i> (bool)</dt> <dd> flag indicating to get the patches missing in the - series file (boolean) + series file </dd> </dl> <a NAME="HgQueuesListDialog.__getTop" ID="HgQueuesListDialog.__getTop"></a> @@ -202,9 +202,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the patch (string) +name of the patch </dd> </dl> <a NAME="HgQueuesListDialog.__processOutputLine" ID="HgQueuesListDialog.__processOutputLine"></a> @@ -216,9 +216,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -output line to be processed (string) +output line to be processed </dd> </dl> <a NAME="HgQueuesListDialog.__resizeColumns" ID="HgQueuesListDialog.__resizeColumns"></a> @@ -244,9 +244,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgQueuesListDialog.closeEvent" ID="HgQueuesListDialog.closeEvent"></a> @@ -258,9 +258,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgQueuesListDialog.on_buttonBox_clicked" ID="HgQueuesListDialog.on_buttonBox_clicked"></a> @@ -272,9 +272,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgQueuesListDialog.start" ID="HgQueuesListDialog.start"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListGuardsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListGuardsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -86,17 +86,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>patchesList</i></dt> +<dt><i>patchesList</i> (list of str)</dt> <dd> -list of patches (list of strings) +list of patches </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgQueuesListGuardsDialog.closeEvent" ID="HgQueuesListGuardsDialog.closeEvent"></a> @@ -108,9 +108,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgQueuesListGuardsDialog.on_patchSelector_activated" ID="HgQueuesListGuardsDialog.on_patchSelector_activated"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesNewPatchDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesNewPatchDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -102,18 +102,18 @@ </p> <dl> -<dt><i>mode</i></dt> +<dt><i>mode</i> (int)</dt> <dd> mode of the dialog (HgQueuesNewPatchDialog.NEW_MODE, HgQueuesNewPatchDialog.REFRESH_MODE) </dd> -<dt><i>message</i></dt> +<dt><i>message</i> (str)</dt> <dd> -text to set as the commit message (string) +text to set as the commit message </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <dl> @@ -144,8 +144,14 @@ flag indicating to set the user, a flag indicating to use the current user and the user name and another tuple giving a flag indicating to set the date, a flag indicating to use the - current date and the date (string, string, (boolean, boolean, - string), (boolean, boolean, string)) + current date and the date +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, tuple of (bool, bool, str), tuple of + (bool, bool, str)) </dd> </dl> <a NAME="HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled" ID="HgQueuesNewPatchDialog.on_currentUserCheckBox_toggled"></a> @@ -157,9 +163,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -flag giving the checked state (boolean) +flag giving the checked state </dd> </dl> <a NAME="HgQueuesNewPatchDialog.on_messageEdit_textChanged" ID="HgQueuesNewPatchDialog.on_messageEdit_textChanged"></a> @@ -178,9 +184,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="HgQueuesNewPatchDialog.on_userEdit_textChanged" ID="HgQueuesNewPatchDialog.on_userEdit_textChanged"></a> @@ -192,9 +198,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="HgQueuesNewPatchDialog.on_userGroup_toggled" ID="HgQueuesNewPatchDialog.on_userGroup_toggled"></a> @@ -206,9 +212,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -flag giving the checked state (boolean) +flag giving the checked state </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesQueueManagementDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesQueueManagementDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -98,28 +98,28 @@ </p> <dl> -<dt><i>mode</i></dt> +<dt><i>mode</i> (int)</dt> <dd> mode of the dialog (HgQueuesQueueManagementDialog.NO_INPUT HgQueuesQueueManagementDialog.NAME_INPUT, HgQueuesQueueManagementDialog.QUEUE_INPUT) </dd> -<dt><i>title</i></dt> +<dt><i>title</i> (str)</dt> <dd> -title for the dialog (string) +title for the dialog </dd> -<dt><i>suppressActive</i></dt> +<dt><i>suppressActive</i> (bool)</dt> <dd> flag indicating to not show the name of the - active queue (boolean) + active queue </dd> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <dl> @@ -140,8 +140,13 @@ <dl> <dt>Return:</dt> <dd> -tuple with a list of all queues and the name of the active - queue (list of strings, string) +tuple with a list of all queues and the name of the active queue +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, str) </dd> </dl> <a NAME="HgQueuesQueueManagementDialog.getData" ID="HgQueuesQueueManagementDialog.getData"></a> @@ -154,7 +159,13 @@ <dl> <dt>Return:</dt> <dd> -queue name (string) +queue name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="HgQueuesQueueManagementDialog.on_buttonBox_clicked" ID="HgQueuesQueueManagementDialog.on_buttonBox_clicked"></a> @@ -166,9 +177,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgQueuesQueueManagementDialog.on_nameEdit_textChanged" ID="HgQueuesQueueManagementDialog.on_nameEdit_textChanged"></a> @@ -180,9 +191,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged" ID="HgQueuesQueueManagementDialog.on_queuesList_itemSelectionChanged"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesRenamePatchDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesRenamePatchDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -94,17 +94,17 @@ </p> <dl> -<dt><i>currentPatch</i></dt> +<dt><i>currentPatch</i> (str)</dt> <dd> -name of the current patch (string) +name of the current patch </dd> -<dt><i>patchesList</i></dt> +<dt><i>patchesList</i> (list of str)</dt> <dd> -list of patches to select from (list of strings) +list of patches to select from </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgQueuesRenamePatchDialog.__updateUI" ID="HgQueuesRenamePatchDialog.__updateUI"></a> @@ -124,7 +124,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of new name and selected patch (string, string) +tuple of new name and selected patch +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) </dd> </dl> <a NAME="HgQueuesRenamePatchDialog.on_nameCombo_currentIndexChanged" ID="HgQueuesRenamePatchDialog.on_nameCombo_currentIndexChanged"></a> @@ -150,9 +156,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the edit (string) +text of the edit </dd> </dl> <a NAME="HgQueuesRenamePatchDialog.on_namedButton_toggled" ID="HgQueuesRenamePatchDialog.on_namedButton_toggled"></a> @@ -164,9 +170,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -state of the check box (boolean) +state of the check box </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -520,23 +520,23 @@ </p> <dl> -<dt><i>operation</i></dt> +<dt><i>operation</i> (int)</dt> <dd> operation type to be performed (Queues.POP, Queues.PUSH, Queues.GOTO) </dd> -<dt><i>doAll</i></dt> +<dt><i>doAll</i> (bool)</dt> <dd> -flag indicating to push/pop all (boolean) +flag indicating to push/pop all </dd> -<dt><i>named</i></dt> +<dt><i>named</i> (bool)</dt> <dd> flag indicating to push/pop until a named patch - is at the top of the stack (boolean) + is at the top of the stack </dd> -<dt><i>force</i></dt> +<dt><i>force</i> (bool)</dt> <dd> -flag indicating a forceful pop (boolean) +flag indicating a forceful pop </dd> </dl> <a NAME="QueuesProjectHelper.__hgQueueRefreshPatch" ID="QueuesProjectHelper.__hgQueueRefreshPatch"></a> @@ -639,15 +639,21 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> -reference to the main menu (QMenu) +reference to the main menu </dd> </dl> <dl> <dt>Return:</dt> <dd> -populated menu (QMenu) +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="QueuesProjectHelper.menuTitle" ID="QueuesProjectHelper.menuTitle"></a> @@ -660,7 +666,13 @@ <dl> <dt>Return:</dt> <dd> -title of the menu (string) +title of the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html Sat Dec 23 15:40:23 2023 +0100 @@ -182,7 +182,7 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the Mercurial vcs object </dd> @@ -197,7 +197,13 @@ <dl> <dt>Return:</dt> <dd> -name of the current patch (string) +name of the current patch +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a> @@ -210,7 +216,13 @@ <dl> <dt>Return:</dt> <dd> -name of the current patch (string) +name of the current patch +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a> @@ -222,20 +234,26 @@ </p> <dl> -<dt><i>listType</i></dt> +<dt><i>listType</i> (int)</dt> <dd> type of patches list to get (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST) </dd> -<dt><i>withSummary</i></dt> +<dt><i>withSummary</i> (bool)</dt> <dd> -flag indicating to get a summary as well (boolean) +flag indicating to get a summary as well </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of patches (list of string) +list of patches +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <dl> @@ -254,15 +272,21 @@ </p> <dl> -<dt><i>allGuards</i></dt> +<dt><i>allGuards</i> (bool)</dt> <dd> -flag indicating to get all guards (boolean) +flag indicating to get all guards </dd> </dl> <dl> <dt>Return:</dt> <dd> -sorted list of guards (list of strings) +sorted list of guards +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a> @@ -274,9 +298,9 @@ </p> <dl> -<dt><i>isCreate</i></dt> +<dt><i>isCreate</i> (bool)</dt> <dd> -flag indicating to create a new queue (boolean) +flag indicating to create a new queue </dd> </dl> <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a> @@ -296,7 +320,7 @@ </p> <dl> -<dt><i>operation</i></dt> +<dt><i>operation</i> (int)</dt> <dd> operation to be performed (Queues.QUEUE_DELETE, Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE) @@ -410,29 +434,35 @@ </p> <dl> -<dt><i>operation</i></dt> +<dt><i>operation</i> (int)</dt> <dd> operation type to be performed (Queues.POP, Queues.PUSH, Queues.GOTO) </dd> -<dt><i>doAll</i></dt> +<dt><i>doAll</i> (bool)</dt> <dd> -flag indicating to push/pop all (boolean) +flag indicating to push/pop all </dd> -<dt><i>named</i></dt> +<dt><i>named</i> (bool)</dt> <dd> flag indicating to push/pop until a named patch - is at the top of the stack (boolean) + is at the top of the stack </dd> -<dt><i>force</i></dt> +<dt><i>force</i> (bool)</dt> <dd> -flag indicating a forceful pop (boolean) +flag indicating a forceful pop </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <dl> @@ -451,10 +481,10 @@ </p> <dl> -<dt><i>editMessage</i></dt> +<dt><i>editMessage</i> (bool)</dt> <dd> flag indicating to edit the current - commit message (boolean) + commit message </dd> </dl> <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a> @@ -480,9 +510,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name (string) +file/directory name </dd> </dl> <a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a> @@ -494,9 +524,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -directory name (string) +directory name </dd> </dl> <a NAME="Queues.shutdown" ID="Queues.shutdown"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -133,15 +133,21 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> -reference to the main menu (QMenu) +reference to the main menu </dd> </dl> <dl> <dt>Return:</dt> <dd> -populated menu (QMenu) +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="RebaseProjectHelper.menuTitle" ID="RebaseProjectHelper.menuTitle"></a> @@ -154,7 +160,13 @@ <dl> <dt>Return:</dt> <dd> -title of the menu (string) +title of the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.rebase.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.rebase.html Sat Dec 23 15:40:23 2023 +0100 @@ -86,7 +86,7 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the Mercurial vcs object </dd> @@ -101,7 +101,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Rebase.hgRebaseAbort" ID="Rebase.hgRebaseAbort"></a> @@ -114,7 +120,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Rebase.hgRebaseContinue" ID="Rebase.hgRebaseContinue"></a> @@ -127,7 +139,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -142,13 +142,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="HgShelveBrowserDialog.__cleanupShelves" ID="HgShelveBrowserDialog.__cleanupShelves"></a> @@ -182,29 +182,28 @@ </p> <dl> -<dt><i>name</i></dt> -<dd> -name of the shelve (string) -</dd> -<dt><i>age</i></dt> +<dt><i>name</i> (str)</dt> <dd> -age of the shelve (string) +name of the shelve </dd> -<dt><i>message</i></dt> +<dt><i>age</i> (str)</dt> <dd> -shelve message (string) +age of the shelve </dd> -<dt><i>fileStatistics</i></dt> +<dt><i>message</i> (str)</dt> <dd> -per file change statistics (tuple of - four strings with file name, number of changes, number of - added lines and number of deleted lines) +shelve message </dd> -<dt><i>totals</i></dt> +<dt><i>fileStatistics</i> (tuple of (str, str, str, str))</dt> <dd> -overall statistics (tuple of three strings with - number of changed files, number of added lines and number - of deleted lines) +per file change statistics (tuple containing the + file name, the number of changes, the number of added lines and the + number of deleted lines) +</dd> +<dt><i>totals</i> (tuple of (str, str, str))</dt> +<dd> +overall statistics (tuple containing the number of changed files, + the number of added lines and the number of deleted lines) </dd> </dl> <a NAME="HgShelveBrowserDialog.__getShelveEntries" ID="HgShelveBrowserDialog.__getShelveEntries"></a> @@ -244,9 +243,9 @@ </p> <dl> -<dt><i>out</i></dt> +<dt><i>out</i> (str)</dt> <dd> -error to be shown (string) +error to be shown </dd> </dl> <a NAME="HgShelveBrowserDialog.__unshelve" ID="HgShelveBrowserDialog.__unshelve"></a> @@ -265,9 +264,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="HgShelveBrowserDialog.on_buttonBox_clicked" ID="HgShelveBrowserDialog.on_buttonBox_clicked"></a> @@ -279,9 +278,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="HgShelveBrowserDialog.on_refreshButton_clicked" ID="HgShelveBrowserDialog.on_refreshButton_clicked"></a> @@ -300,13 +299,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QTreeWidgetItem)</dt> <dd> -reference to the new current item (QTreeWidgetItem) +reference to the new current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QTreeWidgetItem)</dt> <dd> -reference to the old current item (QTreeWidgetItem) +reference to the old current item </dd> </dl> <a NAME="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested" ID="HgShelveBrowserDialog.on_shelveList_customContextMenuRequested"></a> @@ -318,9 +317,9 @@ </p> <dl> -<dt><i>pos</i></dt> +<dt><i>pos</i> (QPoint)</dt> <dd> -position of the mouse pointer (QPoint) +position of the mouse pointer </dd> </dl> <a NAME="HgShelveBrowserDialog.show" ID="HgShelveBrowserDialog.show"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelvesSelectionDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelvesSelectionDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -82,17 +82,17 @@ </p> <dl> -<dt><i>message</i></dt> +<dt><i>message</i> (str)</dt> <dd> -message to be shown (string) +message to be shown </dd> -<dt><i>shelveNames</i></dt> +<dt><i>shelveNames</i> (list of str)</dt> <dd> -list of shelve names (list of string) +list of shelve names </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgShelvesSelectionDialog.getSelectedShelves" ID="HgShelvesSelectionDialog.getSelectedShelves"></a> @@ -105,7 +105,13 @@ <dl> <dt>Return:</dt> <dd> -selected shelve names (list of string) +selected shelve names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="HgShelvesSelectionDialog.on_shelvesList_itemSelectionChanged" ID="HgShelvesSelectionDialog.on_shelvesList_itemSelectionChanged"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgUnshelveDataDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgUnshelveDataDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,17 +78,17 @@ </p> <dl> -<dt><i>shelveNames</i></dt> +<dt><i>shelveNames</i> (list of str)</dt> <dd> -list of available shelves (list of string) +list of available shelves </dd> -<dt><i>shelveName</i></dt> +<dt><i>shelveName</i> (str)</dt> <dd> -name of the shelve to restore (string) +name of the shelve to restore </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="HgUnshelveDataDialog.getData" ID="HgUnshelveDataDialog.getData"></a> @@ -101,8 +101,14 @@ <dl> <dt>Return:</dt> <dd> -tuple containing the name (string) and a flag indicating - to keep the shelved change (boolean) +tuple containing the name and a flag indicating to keep the + shelved change +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -94,15 +94,15 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Hg)</dt> <dd> reference to the vcs object </dd> -<dt><i>browserObject</i></dt> +<dt><i>browserObject</i> (ProjectBaseBrowser)</dt> <dd> reference to the project browser object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</i> (Project)</dt> <dd> reference to the project object </dd> @@ -123,14 +123,14 @@ </p> <dl> -<dt><i>shouldReopen</i></dt> +<dt><i>shouldReopen</i> (bool)</dt> <dd> flag indicating that the project should - be reopened (boolean) + be reopened </dd> -<dt><i>title</i></dt> +<dt><i>title</i> (str)</dt> <dd> -title of the message box (string) +title of the message box </dd> </dl> <a NAME="ShelveProjectBrowserHelper.initMenus" ID="ShelveProjectBrowserHelper.initMenus"></a> @@ -143,9 +143,14 @@ <dl> <dt>Return:</dt> <dd> -dictionary of populated menu (dict of QMenu). The dict - must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' - and 'dirMultiMenu'. +dictionary of populated menu. The dict must have the keys 'mainMenu', + 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict of QMenu </dd> </dl> <a NAME="ShelveProjectBrowserHelper.menuTitle" ID="ShelveProjectBrowserHelper.menuTitle"></a> @@ -158,7 +163,13 @@ <dl> <dt>Return:</dt> <dd> -title of the menu (string) +title of the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="ShelveProjectBrowserHelper.showExtensionMenu" ID="ShelveProjectBrowserHelper.showExtensionMenu"></a> @@ -170,16 +181,15 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> -menu key (string, one of 'mainMenu', 'multiMenu', - 'backMenu', 'dirMenu' or 'dirMultiMenu') +menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' + or 'dirMultiMenu') </dd> -<dt><i>controlled</i></dt> +<dt><i>controlled</i> (bool)</dt> <dd> flag indicating to prepare the menu for a version controlled entry or a non-version controlled entry - (boolean) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -174,14 +174,14 @@ </p> <dl> -<dt><i>shouldReopen</i></dt> +<dt><i>shouldReopen</i> (bool)</dt> <dd> flag indicating that the project should - be reopened (boolean) + be reopened </dd> -<dt><i>title</i></dt> +<dt><i>title</i> (str)</dt> <dd> -title of the message box (string) +title of the message box </dd> </dl> <a NAME="ShelveProjectHelper.initActions" ID="ShelveProjectHelper.initActions"></a> @@ -200,15 +200,21 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> -reference to the main menu (QMenu) +reference to the main menu </dd> </dl> <dl> <dt>Return:</dt> <dd> -populated menu (QMenu) +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="ShelveProjectHelper.menuTitle" ID="ShelveProjectHelper.menuTitle"></a> @@ -221,7 +227,13 @@ <dl> <dt>Return:</dt> <dd> -title of the menu (string) +title of the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html Sat Dec 23 15:40:23 2023 +0100 @@ -110,7 +110,7 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Hg)</dt> <dd> reference to the Mercurial vcs object </dd> @@ -125,7 +125,13 @@ <dl> <dt>Return:</dt> <dd> -list of shelved changes (list of string) +list of shelved changes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Shelve.hgCleanupShelves" ID="Shelve.hgCleanupShelves"></a> @@ -144,9 +150,9 @@ </p> <dl> -<dt><i>shelveNames</i></dt> +<dt><i>shelveNames</i> (list of str)</dt> <dd> -name of shelves to delete (list of string) +name of shelves to delete </dd> </dl> <a NAME="Shelve.hgShelve" ID="Shelve.hgShelve"></a> @@ -158,16 +164,22 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (list of str)</dt> <dd> directory or file name (string) or list of directory - or file names (list of string) + or file names </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Shelve.hgShelveBrowser" ID="Shelve.hgShelveBrowser"></a> @@ -186,15 +198,21 @@ </p> <dl> -<dt><i>shelveName</i></dt> +<dt><i>shelveName</i> (str)</dt> <dd> -name of the shelve to restore (string) +name of the shelve to restore </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Shelve.hgUnshelveAbort" ID="Shelve.hgUnshelveAbort"></a> @@ -207,7 +225,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Shelve.hgUnshelveContinue" ID="Shelve.hgUnshelveContinue"></a> @@ -220,7 +244,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Shelve.shutdown" ID="Shelve.shutdown"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.StripExtension.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.StripExtension.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -119,7 +119,13 @@ <dl> <dt>Return:</dt> <dd> -populated menu (QMenu) +populated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="StripProjectHelper.menuTitle" ID="StripProjectHelper.menuTitle"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html Sat Dec 23 15:40:23 2023 +0100 @@ -564,17 +564,17 @@ </p> <dl> -<dt><i>plugin</i></dt> +<dt><i>plugin</i> (VcsMercurialPlugin)</dt> <dd> reference to the plugin object </dd> -<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="Hg.__checkDefaults" ID="Hg.__checkDefaults"></a> @@ -615,15 +615,21 @@ </p> <dl> -<dt><i>incoming</i></dt> +<dt><i>incoming</i> (bool)</dt> <dd> -flag indicating to get incoming bookmarks (boolean) +flag indicating to get incoming bookmarks </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of bookmarks (list of string) +list of bookmarks +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Hg.__getMostRecentCommitMessage" ID="Hg.__getMostRecentCommitMessage"></a> @@ -659,19 +665,25 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file name to get from the repository (string) +file name to get from the repository </dd> -<dt><i>rev</i></dt> +<dt><i>rev</i> (str)</dt> <dd> -revision to retrieve (string) +revision to retrieve </dd> </dl> <dl> <dt>Return:</dt> <dd> -contents of the file (string) and an error message (string) +contents of the file (string) and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Hg.__hgGraftSubCommand" ID="Hg.__hgGraftSubCommand"></a> @@ -713,9 +725,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -name of the changed file (string) +name of the changed file </dd> </dl> <a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a> @@ -750,20 +762,25 @@ </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 (Project) +reference to the project object </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the monitor thread (QThread) +reference to the monitor thread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +HgStatusMonitorThread </dd> </dl> <a NAME="Hg.canCommitMerge" ID="Hg.canCommitMerge"></a> @@ -796,7 +813,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating pull capability (boolean) +flag indicating pull capability +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.canPush" ID="Hg.canPush"></a> @@ -809,7 +832,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating push capability (boolean) +flag indicating push capability +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a> @@ -829,7 +858,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the client (HgClient) +reference to the client +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +HgClient </dd> </dl> <a NAME="Hg.getEncoding" ID="Hg.getEncoding"></a> @@ -842,7 +877,13 @@ <dl> <dt>Return:</dt> <dd> -encoding (string) +encoding +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a> @@ -854,15 +895,21 @@ </p> <dl> -<dt><i>extensionName</i></dt> +<dt><i>extensionName</i> (str)</dt> <dd> -name of the extension (string) +name of the extension </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the extension object (boolean) +reference to the extension object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.getHgSubPath" ID="Hg.getHgSubPath"></a> @@ -876,7 +923,13 @@ <dl> <dt>Return:</dt> <dd> -full path of the .hgsub file (string) +full path of the .hgsub file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a> @@ -889,7 +942,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the plugin object (VcsMercurialPlugin) +reference to the plugin object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +VcsMercurialPlugin </dd> </dl> <a NAME="Hg.hasSubrepositories" ID="Hg.hasSubrepositories"></a> @@ -902,7 +961,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the existence of sub-repositories (boolean) +flag indicating the existence of sub-repositories +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.hgAbortMerge" ID="Hg.hgAbortMerge"></a> @@ -915,8 +980,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating, that the abortion contained an add - or delete (boolean) +flag indicating, that the abortion contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.hgAddSubrepository" ID="Hg.hgAddSubrepository"></a> @@ -990,13 +1060,13 @@ </p> <dl> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision to set bookmark for (string) +revision to set bookmark for </dd> -<dt><i>bookmark</i></dt> +<dt><i>bookmark</i> (str)</dt> <dd> -name of the bookmark (string) +name of the bookmark </dd> </dl> <a NAME="Hg.hgBookmarkDelete" ID="Hg.hgBookmarkDelete"></a> @@ -1008,9 +1078,9 @@ </p> <dl> -<dt><i>bookmark</i></dt> +<dt><i>bookmark</i> (str)</dt> <dd> -name of the bookmark (string) +name of the bookmark </dd> </dl> <a NAME="Hg.hgBookmarkIncoming" ID="Hg.hgBookmarkIncoming"></a> @@ -1029,13 +1099,13 @@ </p> <dl> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision to set bookmark for (string) +revision to set bookmark for </dd> -<dt><i>bookmark</i></dt> +<dt><i>bookmark</i> (str)</dt> <dd> -name of the bookmark (string) +name of the bookmark </dd> </dl> <a NAME="Hg.hgBookmarkOutgoing" ID="Hg.hgBookmarkOutgoing"></a> @@ -1136,11 +1206,11 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name to be copied (string) +file/directory name to be copied </dd> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> @@ -1148,7 +1218,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating successful operation (boolean) +flag indicating successful operation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.hgCreateIgnoreFile" ID="Hg.hgCreateIgnoreFile"></a> @@ -1160,13 +1236,13 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -directory name to create the ignore file in (string) +directory name to create the ignore file in </dd> -<dt><i>autoAdd</i></dt> +<dt><i>autoAdd</i> (bool)</dt> <dd> -flag indicating to add it automatically (boolean) +flag indicating to add it automatically </dd> </dl> <dl> @@ -1175,6 +1251,12 @@ flag indicating success </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="Hg.hgDeleteBackups" ID="Hg.hgDeleteBackups"></a> <h4>Hg.hgDeleteBackups</h4> <b>hgDeleteBackups</b>(<i></i>) @@ -1239,9 +1321,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> <a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a> @@ -1254,7 +1336,13 @@ <dl> <dt>Return:</dt> <dd> -list of bookmarks (list of string) +list of bookmarks +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a> @@ -1318,17 +1406,22 @@ </p> <dl> -<dt><i>withType</i></dt> +<dt><i>withType</i> (bool)</dt> <dd> -flag indicating to get the tag type as well (boolean) +flag indicating to get the tag type as well </dd> </dl> <dl> <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 - and boolean), if withType is True +list of tags or list of tuples of tag name and flag indicating + a local tag, if withType is True +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str or list of [(str, bool)] </dd> </dl> <a NAME="Hg.hgGraft" ID="Hg.hgGraft"></a> @@ -1340,16 +1433,21 @@ </p> <dl> -<dt><i>revs</i></dt> +<dt><i>revs</i> (list of str)</dt> <dd> -list of revisions to show in the revisions pane (list of - strings) +list of revisions to show in the revisions pane </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating that the project should be reread (boolean) +flag indicating that the project should be reread +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.hgGraftAbort" ID="Hg.hgGraftAbort"></a> @@ -1428,7 +1526,13 @@ <dt>Return:</dt> <dd> flag indicating, that the import contained an add, a delete - or a change to the project file (boolean) + or a change to the project file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a> @@ -1448,10 +1552,9 @@ </p> <dl> -<dt><i>mode</i></dt> +<dt><i>mode</i> (str)</dt> <dd> -mode of the operation (string, one of heads, parents, - tip) +mode of the operation (one of 'heads', 'parents', 'tip') </dd> </dl> <a NAME="Hg.hgListBookmarks" ID="Hg.hgListBookmarks"></a> @@ -1470,10 +1573,10 @@ </p> <dl> -<dt><i>tags</i></dt> +<dt><i>tags</i> (bool)</dt> <dd> flag indicating listing of branches or tags - (False = branches, True = tags) + (False = branches, True = tags) </dd> </dl> <a NAME="Hg.hgNormalizeURL" ID="Hg.hgNormalizeURL"></a> @@ -1485,15 +1588,21 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -url string (string) +url string </dd> </dl> <dl> <dt>Return:</dt> <dd> -properly normalized url for mercurial (string) +properly normalized url for mercurial +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a> @@ -1513,16 +1622,22 @@ </p> <dl> -<dt><i>data</i></dt> +<dt><i>data</i> (tuple of (list of str, str, bool))</dt> <dd> tuple giving phase data (list of revisions, phase, flag - indicating a forced operation) (list of strings, string, boolean) + indicating a forced operation) </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> @@ -1576,17 +1691,17 @@ </p> <dl> -<dt><i>force</i></dt> +<dt><i>force</i> (bool)</dt> <dd> -flag indicating a forced push (boolean) +flag indicating a forced push </dd> -<dt><i>newBranch</i></dt> +<dt><i>newBranch</i> (bool)</dt> <dd> -flag indicating to push a new branch (boolean) +flag indicating to push a new branch </dd> -<dt><i>rev</i></dt> +<dt><i>rev</i> (str)</dt> <dd> -revision to be pushed (including all ancestors) (string) +revision to be pushed (including all ancestors) </dd> </dl> <a NAME="Hg.hgReMerge" ID="Hg.hgReMerge"></a> @@ -1598,9 +1713,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> <a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a> @@ -1669,14 +1784,14 @@ </p> <dl> -<dt><i>mq</i></dt> +<dt><i>mq</i> (bool)</dt> <dd> -flag indicating to show the queue status as well (boolean) +flag indicating to show the queue status as well </dd> -<dt><i>largefiles</i></dt> +<dt><i>largefiles</i> (bool)</dt> <dd> flag indicating to show the largefiles status as - well (boolean) + well </dd> </dl> <a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a> @@ -1722,15 +1837,21 @@ </p> <dl> -<dt><i>command</i></dt> +<dt><i>command</i> (str)</dt> <dd> -command name (string) +command name </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of command options (list of string) +list of command options +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a> @@ -1742,15 +1863,21 @@ </p> <dl> -<dt><i>extensionName</i></dt> +<dt><i>extensionName</i> (str)</dt> <dd> -name of the extension to check for (string) +name of the extension to check for </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating an active extension (boolean) +flag indicating an active extension +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.stopClient" ID="Hg.stopClient"></a> @@ -1769,15 +1896,15 @@ </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 </dd> @@ -1792,13 +1919,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> <a NAME="Hg.vcsAddCommitMessage" ID="Hg.vcsAddCommitMessage"></a> @@ -1825,10 +1952,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str or list of str)</dt> <dd> -root directory of the tree to be added (string or list of - strings)) +root directory of the tree to be added </dd> </dl> <a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a> @@ -1846,17 +1972,17 @@ </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> -<dt><i>shortcut</i></dt> +<dt><i>shortcut</i> (bool)</dt> <dd> -flag indicating a shortcut should be taken (boolean) +flag indicating a shortcut should be taken </dd> </dl> <dl> @@ -1866,6 +1992,12 @@ canBeCommited and canBeAdded or None in order to signal an error </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a> <h4>Hg.vcsCheckout</h4> <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) @@ -1876,15 +2008,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> @@ -1892,7 +2024,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> <a NAME="Hg.vcsCleanup" ID="Hg.vcsCleanup"></a> @@ -1904,9 +2042,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> <a NAME="Hg.vcsClearCommitMessages" ID="Hg.vcsClearCommitMessages"></a> @@ -1925,9 +2063,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> <a NAME="Hg.vcsCommit" ID="Hg.vcsCommit"></a> @@ -1940,30 +2078,29 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be committed (string or list of - strings) +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 </dd> -<dt><i>closeBranch</i></dt> +<dt><i>closeBranch</i> (bool)</dt> <dd> -flag indicating a close branch commit (boolean) +flag indicating a close branch commit </dd> -<dt><i>mq</i></dt> +<dt><i>mq</i> (bool)</dt> <dd> -flag indicating a queue commit (boolean) +flag indicating a queue commit </dd> -<dt><i>merge</i></dt> +<dt><i>merge</i> (bool)</dt> <dd> -flag indicating a merge commit (boolean) +flag indicating a merge commit </dd> </dl> <a NAME="Hg.vcsCommitMessages" ID="Hg.vcsCommitMessages"></a> @@ -2024,9 +2161,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> <a NAME="Hg.vcsExists" ID="Hg.vcsExists"></a> @@ -2039,8 +2176,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the existence (boolean) and an error message - (string) +flag indicating the existence and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) </dd> </dl> <a NAME="Hg.vcsExport" ID="Hg.vcsExport"></a> @@ -2052,19 +2194,25 @@ </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> </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> <a NAME="Hg.vcsForget" ID="Hg.vcsForget"></a> @@ -2094,15 +2242,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) @@ -2114,6 +2262,12 @@ the project browser helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +HgProjectBrowserHelper +</dd> +</dl> <a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a> <h4>Hg.vcsGetProjectHelper</h4> <b>vcsGetProjectHelper</b>(<i>project</i>) @@ -2123,7 +2277,7 @@ </p> <dl> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> @@ -2134,6 +2288,12 @@ the project helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +HgProjectHelper +</dd> +</dl> <a NAME="Hg.vcsImport" ID="Hg.vcsImport"></a> <h4>Hg.vcsImport</h4> <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) @@ -2149,7 +2309,7 @@ </dd> <dt><i>projectDir</i> (str)</dt> <dd> -project directory (string) +project directory </dd> <dt><i>noDialog</i> (bool)</dt> <dd> @@ -2187,19 +2347,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> -always TRUE +always True +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a> @@ -2214,9 +2380,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="Hg.vcsLogBrowser" ID="Hg.vcsLogBrowser"></a> @@ -2229,14 +2395,13 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name to show the log of (string) +file/directory name to show the log of </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> <a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a> @@ -2266,19 +2431,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> @@ -2286,7 +2451,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> <a NAME="Hg.vcsName" ID="Hg.vcsName"></a> @@ -2299,7 +2470,13 @@ <dl> <dt>Return:</dt> <dd> -always 'Mercurial' (string) +always 'Mercurial' +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Hg.vcsNewProjectOptionsDialog" ID="Hg.vcsNewProjectOptionsDialog"></a> @@ -2312,16 +2489,21 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <dl> <dt>Return:</dt> <dd> reference to the instantiated options dialog - (HgNewProjectOptionsDialog) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +HgNewProjectOptionsDialog </dd> </dl> <a NAME="Hg.vcsOptionsDialog" ID="Hg.vcsOptionsDialog"></a> @@ -2333,28 +2515,33 @@ </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> <dt>Return:</dt> <dd> -reference to the instantiated options dialog (HgOptionsDialog) +reference to the instantiated options dialog +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +HgOptionsDialog </dd> </dl> <a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a> @@ -2374,7 +2561,7 @@ <dl> <dt>Return:</dt> <dd> -a combination of canBeCommited and canBeAdded +registered state (one of canBeCommited and canBeAdded) </dd> </dl> <dl> @@ -2396,17 +2583,15 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be removed (string or list of - strings)) +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) - (not needed) +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> @@ -2414,7 +2599,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> <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a> @@ -2426,15 +2617,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> <a NAME="Hg.vcsResolved" ID="Hg.vcsResolved"></a> @@ -2446,14 +2643,14 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name to be resolved (string) +file/directory name to be resolved </dd> -<dt><i>unresolve</i></dt> +<dt><i>unresolve</i> (bool)</dt> <dd> flag indicating to mark the file/directory as - unresolved (boolean) + unresolved </dd> </dl> <a NAME="Hg.vcsRevert" ID="Hg.vcsRevert"></a> @@ -2493,17 +2690,17 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file name to be diffed (string) +file name to be diffed </dd> -<dt><i>extended</i></dt> +<dt><i>extended</i> (bool)</dt> <dd> -flag indicating the extended variant (boolean) +flag indicating the extended variant </dd> -<dt><i>revisions</i></dt> +<dt><i>revisions</i> (tuple of (str, str))</dt> <dd> -tuple of two revisions (tuple of strings) +tuple of two revisions </dd> </dl> <dl> @@ -2530,10 +2727,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> file/directory name(s) to show the status of - (string or list of strings) </dd> </dl> <a NAME="Hg.vcsSupportCommandOptions" ID="Hg.vcsSupportCommandOptions"></a> @@ -2547,7 +2743,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="Hg.vcsSwitch" ID="Hg.vcsSwitch"></a> @@ -2560,16 +2761,21 @@ </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) +flag indicating, that the switch contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a> @@ -2581,24 +2787,29 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> file/directory name to determine the repo root from - (string) </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision to set tag for (string) +revision to set tag for </dd> -<dt><i>tagName</i></dt> +<dt><i>tagName</i> (str)</dt> <dd> -name of the tag (string) +name of the tag </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a performed tag action (boolean) +flag indicating a performed tag action +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a> @@ -2611,24 +2822,29 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> file/directory name to be updated (not used) </dd> -<dt><i>noDialog</i></dt> +<dt><i>noDialog</i> (bool)</dt> <dd> -flag indicating quiet operations (boolean) +flag indicating quiet operations </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision to update to (string) +revision to update to </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, that the update contained an add - or delete (boolean) +flag indicating, that the update contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.ConfigurationPage.SubversionPage.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.ConfigurationPage.SubversionPage.html Sat Dec 23 15:40:23 2023 +0100 @@ -86,7 +86,7 @@ </p> <dl> -<dt><i>plugin</i></dt> +<dt><i>plugin</i> (VcsPySvnPlugin)</dt> <dd> reference to the plugin object </dd>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.ProjectBrowserHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.ProjectBrowserHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -190,30 +190,30 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>browserObject</i></dt> +<dt><i>browserObject</i> (ProjectBaseBrowser)</dt> <dd> reference to the project browser object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</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) </dd> -<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="SvnProjectBrowserHelper.__SVNAddToChangelist" ID="SvnProjectBrowserHelper.__SVNAddToChangelist"></a> @@ -380,15 +380,21 @@ </p> <dl> -<dt><i>items</i></dt> +<dt><i>items</i> (list of QTreeWidgetItems)</dt> <dd> -items to check (list of QTreeWidgetItems) +items to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating items contain file type items (boolean) +flag indicating items contain file type items +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="SvnProjectBrowserHelper._addVCSMenu" ID="SvnProjectBrowserHelper._addVCSMenu"></a> @@ -400,7 +406,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -414,7 +420,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -428,7 +434,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -442,7 +448,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -457,7 +463,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -475,11 +481,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -498,11 +504,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -521,11 +527,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -545,11 +551,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -150,21 +150,21 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</i> (Project)</dt> <dd> reference to the project object </dd> -<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="PySvnProjectHelper.__svnBranchList" ID="PySvnProjectHelper.__svnBranchList"></a> @@ -277,7 +277,13 @@ <dl> <dt>Return:</dt> <dd> -list of all actions (list of EricAction) +list of all actions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of EricAction </dd> </dl> <a NAME="PySvnProjectHelper.initActions" ID="PySvnProjectHelper.initActions"></a> @@ -296,9 +302,9 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu to be populated (QMenu) +reference to the menu to be populated </dd> </dl> <a NAME="PySvnProjectHelper.initToolbar" ID="PySvnProjectHelper.initToolbar"></a> @@ -310,14 +316,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <a NAME="PySvnProjectHelper.removeToolbar" ID="PySvnProjectHelper.removeToolbar"></a> @@ -329,14 +334,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnBlameDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnBlameDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -98,13 +98,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnBlameDialog.__finish" ID="SvnBlameDialog.__finish"></a> @@ -124,21 +124,21 @@ </p> <dl> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision string (string) +revision string </dd> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author of the change (string) +author of the change </dd> -<dt><i>lineno</i></dt> +<dt><i>lineno</i> (str)</dt> <dd> -linenumber (string) +linenumber </dd> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -line of text from the annotated file (string) +line of text from the annotated file </dd> </dl> <a NAME="SvnBlameDialog.__resizeColumns" ID="SvnBlameDialog.__resizeColumns"></a> @@ -157,9 +157,9 @@ </p> <dl> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -error message to show (string) +error message to show </dd> </dl> <a NAME="SvnBlameDialog.on_buttonBox_clicked" ID="SvnBlameDialog.on_buttonBox_clicked"></a> @@ -171,9 +171,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnBlameDialog.start" ID="SvnBlameDialog.start"></a> @@ -185,9 +185,9 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to show the blame for (string) +filename to show the blame for </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnChangeListsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnChangeListsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,13 +90,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnChangeListsDialog.__finish" ID="SvnChangeListsDialog.__finish"></a> @@ -115,9 +115,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnChangeListsDialog.on_changeLists_currentItemChanged" ID="SvnChangeListsDialog.on_changeLists_currentItemChanged"></a> @@ -129,13 +129,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QListWidgetItem)</dt> <dd> -current item (QListWidgetItem) +current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QListWidgetItem)</dt> <dd> -previous current item (QListWidgetItem) +previous current item </dd> </dl> <a NAME="SvnChangeListsDialog.start" ID="SvnChangeListsDialog.start"></a> @@ -147,9 +147,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -directory name to show change lists for (string) +directory name to show change lists for </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnCommandDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnCommandDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -87,21 +87,21 @@ </p> <dl> -<dt><i>argvList</i></dt> +<dt><i>argvList</i> (list of str)</dt> <dd> -history list of commandline arguments (list of strings) +history list of commandline arguments </dd> -<dt><i>wdList</i></dt> +<dt><i>wdList</i> (list of str)</dt> <dd> -history list of working directories (list of strings) +history list of working directories </dd> -<dt><i>ppath</i></dt> +<dt><i>ppath</i> (str)</dt> <dd> -pathname of the project directory (string) +pathname of the project directory </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of this dialog (QWidget) +parent widget of this dialog </dd> </dl> <a NAME="SvnCommandDialog.getData" ID="SvnCommandDialog.getData"></a> @@ -114,7 +114,13 @@ <dl> <dt>Return:</dt> <dd> -a tuple of argv, workdir +a tuple containing argv, workdir +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) </dd> </dl> <a NAME="SvnCommandDialog.on_commandCombo_editTextChanged" ID="SvnCommandDialog.on_commandCombo_editTextChanged"></a> @@ -126,9 +132,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -ignored +text of the command combobox </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnCommitDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnCommitDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -72,11 +72,11 @@ </tr> <tr> <td><a href="#SvnCommitDialog.changelistsData">changelistsData</a></td> -<td>Public method to retrieve the changelists data.</td> +<td>Public method to retrieve the change lists data.</td> </tr> <tr> <td><a href="#SvnCommitDialog.hasChangelists">hasChangelists</a></td> -<td>Public method to check, if the user entered some changelists.</td> +<td>Public method to check, if the user entered some change lists.</td> </tr> <tr> <td><a href="#SvnCommitDialog.logMessage">logMessage</a></td> @@ -118,13 +118,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnCommitDialog.changelistsData" ID="SvnCommitDialog.changelistsData"></a> @@ -132,13 +132,19 @@ <b>changelistsData</b>(<i></i>) <p> - Public method to retrieve the changelists data. + Public method to retrieve the change lists data. </p> <dl> <dt>Return:</dt> <dd> -tuple containing the changelists (list of strings) and a flag - indicating to keep changelists (boolean) +tuple containing the change lists and a flag indicating to keep + the change lists +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, bool) </dd> </dl> <a NAME="SvnCommitDialog.hasChangelists" ID="SvnCommitDialog.hasChangelists"></a> @@ -146,12 +152,18 @@ <b>hasChangelists</b>(<i></i>) <p> - Public method to check, if the user entered some changelists. + Public method to check, if the user entered some change lists. </p> <dl> <dt>Return:</dt> <dd> -flag indicating availability of changelists (boolean) +flag indicating availability of change lists +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="SvnCommitDialog.logMessage" ID="SvnCommitDialog.logMessage"></a> @@ -168,7 +180,13 @@ <dl> <dt>Return:</dt> <dd> -the log message (string) +the log message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnCommitDialog.on_buttonBox_accepted" ID="SvnCommitDialog.on_buttonBox_accepted"></a> @@ -187,9 +205,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnCommitDialog.on_buttonBox_rejected" ID="SvnCommitDialog.on_buttonBox_rejected"></a> @@ -222,9 +240,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QShowEvent)</dt> <dd> -the event (QShowEvent) +the event </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnCopyDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnCopyDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -83,21 +83,21 @@ </p> <dl> -<dt><i>source</i></dt> +<dt><i>source</i> (str)</dt> <dd> -name of the source file/directory (string) +name of the source file/directory </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> -<dt><i>move</i></dt> +<dt><i>move</i> (bool)</dt> <dd> -flag indicating a move operation (boolean) +flag indicating a move operation </dd> -<dt><i>force</i></dt> +<dt><i>force</i> (bool)</dt> <dd> -flag indicating a forced operation (boolean) +flag indicating a forced operation </dd> </dl> <a NAME="SvnCopyDialog.getData" ID="SvnCopyDialog.getData"></a> @@ -110,8 +110,13 @@ <dl> <dt>Return:</dt> <dd> -the target name (string) and a flag indicating - the operation should be enforced (boolean) +the target name and a flag indicating the operation should be enforced +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) </dd> </dl> <a NAME="SvnCopyDialog.on_targetPicker_textChanged" ID="SvnCopyDialog.on_targetPicker_textChanged"></a> @@ -123,9 +128,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -contents of the target edit (string) +contents of the target edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -98,26 +98,25 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text to be shown by the label (string) +text to be shown by the label </dd> -<dt><i>command</i></dt> +<dt><i>command</i> (str)</dt> <dd> svn command to be executed (display purposes only) - (string) </dd> -<dt><i>pysvnClient</i></dt> +<dt><i>pysvnClient</i> (pysvn.Client)</dt> <dd> -reference to the pysvn client object (pysvn.Client) +reference to the pysvn client object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> -<dt><i>log</i></dt> +<dt><i>log</i> (str)</dt> <dd> -optional log message (string) +optional log message </dd> </dl> <a NAME="SvnDialog._clientNotifyCallback" ID="SvnDialog._clientNotifyCallback"></a> @@ -129,7 +128,7 @@ </p> <dl> -<dt><i>eventDict</i></dt> +<dt><i>eventDict</i> (dict)</dt> <dd> dictionary containing the notification event </dd> @@ -152,7 +151,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of an add or delete (boolean) +flag indicating the presence of an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="SvnDialog.on_buttonBox_clicked" ID="SvnDialog.on_buttonBox_clicked"></a> @@ -164,9 +169,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnDialog.showError" ID="SvnDialog.showError"></a> @@ -178,9 +183,9 @@ </p> <dl> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -error message to show (string) +error message to show </dd> </dl> <a NAME="SvnDialog.showMessage" ID="SvnDialog.showMessage"></a> @@ -192,9 +197,9 @@ </p> <dl> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -message to show (string) +message to show </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnDialogMixin.html Sat Dec 23 15:40:23 2023 +0100 @@ -100,9 +100,9 @@ </p> <dl> -<dt><i>log</i></dt> +<dt><i>log</i> (str)</dt> <dd> -optional log message (string) +optional log message </dd> </dl> <a NAME="SvnDialogMixin._cancel" ID="SvnDialogMixin._cancel"></a> @@ -125,6 +125,12 @@ flag indicating a cancellation </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="SvnDialogMixin._clientLogCallback" ID="SvnDialogMixin._clientLogCallback"></a> <h4>SvnDialogMixin._clientLogCallback</h4> <b>_clientLogCallback</b>(<i></i>) @@ -135,7 +141,13 @@ <dl> <dt>Return:</dt> <dd> -a flag indicating success and the log message (string) +a flag indicating success and the log message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnDialogMixin._clientLoginCallback" ID="SvnDialogMixin._clientLoginCallback"></a> @@ -147,18 +159,18 @@ </p> <dl> -<dt><i>realm</i></dt> +<dt><i>realm</i> (str)</dt> <dd> -name of the realm of the requested credentials (string) +name of the realm of the requested credentials </dd> -<dt><i>username</i></dt> +<dt><i>username</i> (str)</dt> <dd> -username as supplied by subversion (string) +username as supplied by subversion </dd> -<dt><i>may_save</i></dt> +<dt><i>may_save</i> (bool)</dt> <dd> flag indicating, that subversion is willing to save - the answers returned (boolean) + the answers returned </dd> </dl> <dl> @@ -171,6 +183,12 @@ password should be saved. </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str, str, bool) +</dd> +</dl> <a NAME="SvnDialogMixin._clientSslServerTrustPromptCallback" ID="SvnDialogMixin._clientSslServerTrustPromptCallback"></a> <h4>SvnDialogMixin._clientSslServerTrustPromptCallback</h4> <b>_clientSslServerTrustPromptCallback</b>(<i>trust_dict</i>) @@ -181,7 +199,7 @@ </p> <dl> -<dt><i>trust_dict</i></dt> +<dt><i>trust_dict</i> (dict)</dt> <dd> dictionary containing the trust data </dd> @@ -190,11 +208,17 @@ <dt>Return:</dt> <dd> tuple of three values (retcode, acceptedFailures, save). - Retcode should be true, if the certificate should be accepted, + Retcode should be True, if the certificate should be accepted, acceptedFailures should indicate the accepted certificate failures and save should be True, if subversion should save the certificate. </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, list of str, bool) +</dd> +</dl> <a NAME="SvnDialogMixin._reset" ID="SvnDialogMixin._reset"></a> <h4>SvnDialogMixin._reset</h4> <b>_reset</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -123,13 +123,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a> @@ -141,9 +141,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -line of text to insert (string) +line of text to insert </dd> </dl> <a NAME="SvnDiffDialog.__extractFileName" ID="SvnDiffDialog.__extractFileName"></a> @@ -155,15 +155,21 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -line to be processed (string) +line to be processed </dd> </dl> <dl> <dt>Return:</dt> <dd> -extracted file name (string) +extracted file name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnDiffDialog.__finish" ID="SvnDiffDialog.__finish"></a> @@ -182,15 +188,21 @@ </p> <dl> -<dt><i>summaryKind</i></dt> +<dt><i>summaryKind</i> (pysvn.diff_summarize.summarize_kind)</dt> <dd> -(pysvn.diff_summarize.summarize_kind) + </dd> </dl> <dl> <dt>Return:</dt> <dd> -one letter string indicating the change type (string) +one letter string indicating the change type +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a> @@ -203,15 +215,21 @@ </p> <dl> -<dt><i>version</i></dt> +<dt><i>version</i> (int or str)</dt> <dd> -revision (integer or string) +revision </dd> </dl> <dl> <dt>Return:</dt> <dd> -revision object (pysvn.Revision) +revision object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +pysvn.Revision </dd> </dl> <a NAME="SvnDiffDialog.__processFileLine" ID="SvnDiffDialog.__processFileLine"></a> @@ -223,9 +241,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -line to be processed (string) +line to be processed </dd> </dl> <a NAME="SvnDiffDialog.__showError" ID="SvnDiffDialog.__showError"></a> @@ -237,9 +255,9 @@ </p> <dl> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -error message to show (string) +error message to show </dd> </dl> <a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a> @@ -251,9 +269,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnDiffDialog.on_filesCombo_activated" ID="SvnDiffDialog.on_filesCombo_activated"></a> @@ -265,9 +283,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -activated row (integer) +activated row </dd> </dl> <a NAME="SvnDiffDialog.on_refreshButton_clicked" ID="SvnDiffDialog.on_refreshButton_clicked"></a> @@ -297,31 +315,30 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to be diffed (string) +filename to be diffed </dd> -<dt><i>versions</i></dt> +<dt><i>versions</i> (list of up to 2 int or None)</dt> <dd> -list of versions to be diffed (list of up to 2 integer - or None) +list of versions to be diffed </dd> -<dt><i>urls</i></dt> +<dt><i>urls</i> (list of [str, str])</dt> <dd> -list of repository URLs (list of 2 strings) +list of repository URLs </dd> -<dt><i>summary</i></dt> +<dt><i>summary</i> (bool)</dt> <dd> flag indicating a summarizing diff - (only valid for URL diffs) (boolean) + (only valid for URL diffs) </dd> -<dt><i>pegRev</i></dt> +<dt><i>pegRev</i> (int)</dt> <dd> -revision number the filename is valid (integer) +revision number the filename is valid </dd> -<dt><i>refreshable</i></dt> +<dt><i>refreshable</i> (bool)</dt> <dd> -flag indicating a refreshable diff (boolean) +flag indicating a refreshable diff </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnDiffHighlighter.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnDiffHighlighter.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,9 +78,9 @@ </p> <dl> -<dt><i>doc</i></dt> +<dt><i>doc</i> (QTextDocument)</dt> <dd> -reference to the text document (QTextDocument) +reference to the text document </dd> </dl> <a NAME="SvnDiffHighlighter.generateRules" ID="SvnDiffHighlighter.generateRules"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnInfoDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnInfoDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -84,13 +84,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnInfoDialog.__showError" ID="SvnInfoDialog.__showError"></a> @@ -102,9 +102,9 @@ </p> <dl> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -error message to show (string) +error message to show </dd> </dl> <a NAME="SvnInfoDialog.start" ID="SvnInfoDialog.start"></a> @@ -116,13 +116,13 @@ </p> <dl> -<dt><i>projectPath</i></dt> +<dt><i>projectPath</i> (str)</dt> <dd> -path name of the project (string) +path name of the project </dd> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -file or directory name relative to the project (string) +file or directory name relative to the project </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnLogBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnLogBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -194,13 +194,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnLogBrowserDialog.__diffRevisions" ID="SvnLogBrowserDialog.__diffRevisions"></a> @@ -212,17 +212,17 @@ </p> <dl> -<dt><i>rev1</i></dt> +<dt><i>rev1</i> (int)</dt> <dd> -first revision number (integer) +first revision number </dd> -<dt><i>rev2</i></dt> +<dt><i>rev2</i> (int)</dt> <dd> -second revision number (integer) +second revision number </dd> -<dt><i>peg_rev</i></dt> +<dt><i>peg_rev</i> (int)</dt> <dd> -revision number to use as a reference (integer) +revision number to use as a reference </dd> </dl> <a NAME="SvnLogBrowserDialog.__filterLogs" ID="SvnLogBrowserDialog.__filterLogs"></a> @@ -248,27 +248,33 @@ </p> <dl> -<dt><i>action</i></dt> +<dt><i>action</i> (str)</dt> <dd> indicator for the change action ("A", "D" or "M") </dd> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -path of the file in the repository (string) +path of the file in the repository </dd> -<dt><i>copyFrom</i></dt> +<dt><i>copyFrom</i> (str)</dt> <dd> -path the file was copied from (None, string) +path the file was copied from </dd> -<dt><i>copyRev</i></dt> +<dt><i>copyRev</i> (str)</dt> <dd> -revision the file was copied from (None, string) +revision the file was copied from </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the generated item (QTreeWidgetItem) +reference to the generated item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem </dd> </dl> <a NAME="SvnLogBrowserDialog.__generateLogItem" ID="SvnLogBrowserDialog.__generateLogItem"></a> @@ -280,23 +286,23 @@ </p> <dl> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author info (string) +author info </dd> -<dt><i>date</i></dt> +<dt><i>date</i> (int)</dt> <dd> -date info (integer) +date info </dd> -<dt><i>message</i></dt> +<dt><i>message</i> (str)</dt> <dd> -text of the log message (string) +text of the log message </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str or pysvn.opt_revision_kind)</dt> <dd> -revision info (string or pysvn.opt_revision_kind) +revision info </dd> -<dt><i>changedPaths</i></dt> +<dt><i>changedPaths</i> (dict like)</dt> <dd> list of pysvn dictionary like objects containing info about the changed files/directories @@ -305,7 +311,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the generated item (QTreeWidgetItem) +reference to the generated item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem </dd> </dl> <a NAME="SvnLogBrowserDialog.__getLogEntries" ID="SvnLogBrowserDialog.__getLogEntries"></a> @@ -317,9 +329,9 @@ </p> <dl> -<dt><i>startRev</i></dt> +<dt><i>startRev</i> (tuple of (int, str))</dt> <dd> -revision number to start from (integer, string) +revision number to start from </dd> </dl> <a NAME="SvnLogBrowserDialog.__initData" ID="SvnLogBrowserDialog.__initData"></a> @@ -373,9 +385,9 @@ </p> <dl> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -error message to show (string) +error message to show </dd> </dl> <a NAME="SvnLogBrowserDialog._reset" ID="SvnLogBrowserDialog._reset"></a> @@ -394,9 +406,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="SvnLogBrowserDialog.on_buttonBox_clicked" ID="SvnLogBrowserDialog.on_buttonBox_clicked"></a> @@ -408,9 +420,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnLogBrowserDialog.on_diffPreviousButton_clicked" ID="SvnLogBrowserDialog.on_diffPreviousButton_clicked"></a> @@ -457,9 +469,9 @@ </p> <dl> -<dt><i>date</i></dt> +<dt><i>date</i> (QDate)</dt> <dd> -new date (QDate) +new date </dd> </dl> <a NAME="SvnLogBrowserDialog.on_logTree_currentItemChanged" ID="SvnLogBrowserDialog.on_logTree_currentItemChanged"></a> @@ -471,13 +483,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QTreeWidgetItem)</dt> <dd> -reference to the new current item (QTreeWidgetItem) +reference to the new current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QTreeWidgetItem)</dt> <dd> -reference to the old current item (QTreeWidgetItem) +reference to the old current item </dd> </dl> <a NAME="SvnLogBrowserDialog.on_logTree_itemSelectionChanged" ID="SvnLogBrowserDialog.on_logTree_itemSelectionChanged"></a> @@ -503,9 +515,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -filter expression (string) +filter expression </dd> </dl> <a NAME="SvnLogBrowserDialog.on_stopCheckBox_clicked" ID="SvnLogBrowserDialog.on_stopCheckBox_clicked"></a> @@ -517,9 +529,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -flag indicating the check box state (boolean) +flag indicating the check box state </dd> </dl> <a NAME="SvnLogBrowserDialog.on_toDate_dateChanged" ID="SvnLogBrowserDialog.on_toDate_dateChanged"></a> @@ -531,9 +543,9 @@ </p> <dl> -<dt><i>date</i></dt> +<dt><i>date</i> (QDate)</dt> <dd> -new date (QDate) +new date </dd> </dl> <a NAME="SvnLogBrowserDialog.on_upButton_clicked" ID="SvnLogBrowserDialog.on_upButton_clicked"></a> @@ -559,14 +571,13 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to show the log for (string) +filename 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> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnLoginDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnLoginDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,22 +78,22 @@ </p> <dl> -<dt><i>realm</i></dt> +<dt><i>realm</i> (str)</dt> <dd> -name of the realm of the requested credentials (string) +name of the realm of the requested credentials </dd> -<dt><i>username</i></dt> +<dt><i>username</i> (str)</dt> <dd> -username as supplied by subversion (string) +username as supplied by subversion </dd> -<dt><i>may_save</i></dt> +<dt><i>may_save</i> (bool)</dt> <dd> flag indicating, that subversion is willing to save - the answers returned (boolean) + the answers returned </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="SvnLoginDialog.getData" ID="SvnLoginDialog.getData"></a> @@ -106,7 +106,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of three values (username, password, save) +tuple containing the username, the password and a flag to save the data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, bool) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnMergeDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnMergeDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,27 +90,25 @@ </p> <dl> -<dt><i>mergelist1</i></dt> +<dt><i>mergelist1</i> (list of str)</dt> <dd> list of previously entered URLs/revisions - (list of strings) </dd> -<dt><i>mergelist2</i></dt> +<dt><i>mergelist2</i> (list of str)</dt> <dd> list of previously entered URLs/revisions - (list of strings) </dd> -<dt><i>targetlist</i></dt> +<dt><i>targetlist</i> (list of str)</dt> <dd> -list of previously entered targets (list of strings) +list of previously entered targets </dd> -<dt><i>force</i></dt> +<dt><i>force</i> (bool)</dt> <dd> -flag indicating a forced merge (boolean) +flag indicating a forced merge </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnMergeDialog.__enableOkButton" ID="SvnMergeDialog.__enableOkButton"></a> @@ -131,7 +129,13 @@ <dt>Return:</dt> <dd> tuple naming two tag names or two revisions, a target and - a flag indicating a forced merge (string, string, string, boolean) + a flag indicating a forced merge +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, str, bool) </dd> </dl> <a NAME="SvnMergeDialog.on_tag1Combo_editTextChanged" ID="SvnMergeDialog.on_tag1Combo_editTextChanged"></a> @@ -143,9 +147,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="SvnMergeDialog.on_tag2Combo_editTextChanged" ID="SvnMergeDialog.on_tag2Combo_editTextChanged"></a> @@ -157,9 +161,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnNewProjectOptionsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnNewProjectOptionsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -100,13 +100,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the version control object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnNewProjectOptionsDialog.getData" ID="SvnNewProjectOptionsDialog.getData"></a> @@ -119,10 +119,16 @@ <dl> <dt>Return:</dt> <dd> -a tuple of a string (project directory) and a dictionary +a tuple containing the project directory and a dictionary containing the data entered. </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, dict) +</dd> +</dl> <a NAME="SvnNewProjectOptionsDialog.on_layoutCheckBox_toggled" ID="SvnNewProjectOptionsDialog.on_layoutCheckBox_toggled"></a> <h4>SvnNewProjectOptionsDialog.on_layoutCheckBox_toggled</h4> <b>on_layoutCheckBox_toggled</b>(<i>checked</i>) @@ -132,9 +138,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -flag indicating the state of the checkbox (boolean) +flag indicating the state of the checkbox </dd> </dl> <a NAME="SvnNewProjectOptionsDialog.on_protocolCombo_activated" ID="SvnNewProjectOptionsDialog.on_protocolCombo_activated"></a> @@ -160,9 +166,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -name of the project directory (string) +name of the project directory </dd> </dl> <a NAME="SvnNewProjectOptionsDialog.on_vcsUrlPicker_pickerButtonClicked" ID="SvnNewProjectOptionsDialog.on_vcsUrlPicker_pickerButtonClicked"></a> @@ -181,9 +187,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -current text of the line edit (string) +current text of the line edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnOptionsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnOptionsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -92,17 +92,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the version control object </dd> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnOptionsDialog.getData" ID="SvnOptionsDialog.getData"></a> @@ -118,6 +118,12 @@ a dictionary containing the data entered </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="SvnOptionsDialog.on_protocolCombo_activated" ID="SvnOptionsDialog.on_protocolCombo_activated"></a> <h4>SvnOptionsDialog.on_protocolCombo_activated</h4> <b>on_protocolCombo_activated</b>(<i>index</i>) @@ -148,9 +154,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -current text of the line edit (string) +current text of the line edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnPropDelDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnPropDelDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -82,13 +82,13 @@ </p> <dl> -<dt><i>recursive</i></dt> +<dt><i>recursive</i> (bool)</dt> <dd> flag indicating a recursive set is requested </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnPropDelDialog.getData" ID="SvnPropDelDialog.getData"></a> @@ -103,7 +103,12 @@ <dd> tuple of two values giving the property name and a flag indicating, that this property should be applied recursively. - (string, boolean) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) </dd> </dl> <a NAME="SvnPropDelDialog.on_propNameEdit_textChanged" ID="SvnPropDelDialog.on_propNameEdit_textChanged"></a> @@ -115,9 +120,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -ignored +text of the property name edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnPropListDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnPropListDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -108,13 +108,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnPropListDialog.__finish" ID="SvnPropListDialog.__finish"></a> @@ -134,17 +134,17 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -file/directory name the property applies to (string) +file/directory name the property applies to </dd> -<dt><i>propName</i></dt> +<dt><i>propName</i> (str)</dt> <dd> -name of the property (string) +name of the property </dd> -<dt><i>propValue</i></dt> +<dt><i>propValue</i> (str)</dt> <dd> -value of the property (string) +value of the property </dd> </dl> <a NAME="SvnPropListDialog.__resizeColumns" ID="SvnPropListDialog.__resizeColumns"></a> @@ -170,9 +170,9 @@ </p> <dl> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -error message to show (string) +error message to show </dd> </dl> <a NAME="SvnPropListDialog.on_buttonBox_clicked" ID="SvnPropListDialog.on_buttonBox_clicked"></a> @@ -184,9 +184,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnPropListDialog.on_refreshButton_clicked" ID="SvnPropListDialog.on_refreshButton_clicked"></a> @@ -205,11 +205,11 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str or list of str)</dt> <dd> -filename(s) (string or list of strings) +filename(s) </dd> -<dt><i>recursive</i></dt> +<dt><i>recursive</i> (bool)</dt> <dd> flag indicating a recursive list is requested </dd>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnPropSetDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnPropSetDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,13 +78,13 @@ </p> <dl> -<dt><i>recursive</i></dt> +<dt><i>recursive</i> (bool)</dt> <dd> flag indicating a recursive set is requested </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnPropSetDialog.getData" ID="SvnPropSetDialog.getData"></a> @@ -97,9 +97,14 @@ <dl> <dt>Return:</dt> <dd> -tuple of three values giving the property name, the text - of the property and a flag indicating, that this property - should be applied recursively. (string, string, boolean) +tuple containing the property name, the text of the property and + a flag indicating, that this property should be applied recursively. +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, bool) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnRelocateDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnRelocateDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,13 +78,13 @@ </p> <dl> -<dt><i>currUrl</i></dt> +<dt><i>currUrl</i> (str)</dt> <dd> -current repository URL (string) +current repository URL </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnRelocateDialog.getData" ID="SvnRelocateDialog.getData"></a> @@ -97,8 +97,14 @@ <dl> <dt>Return:</dt> <dd> -the new repository URL (string) and an indication, if - the relocate is inside the repository (boolean) +the new repository URL and an indication, if the relocate is inside + the repository +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnRepoBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnRepoBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -126,17 +126,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>mode</i></dt> +<dt><i>mode</i> (str)</dt> <dd> -mode of the dialog (string, "browse" or "select") +mode of the dialog ("browse" or "select") </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnRepoBrowserDialog.__generateItem" ID="SvnRepoBrowserDialog.__generateItem"></a> @@ -148,44 +148,49 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt> <dd> -parent of the item to be created (QTreeWidget or - QTreeWidgetItem) +parent of the item to be created </dd> -<dt><i>repopath</i></dt> +<dt><i>repopath</i> (str)</dt> <dd> -path of the item (string) +path of the item </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str or pysvn.opt_revision_kind)</dt> <dd> -revision info (string or pysvn.opt_revision_kind) +revision info </dd> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author info (string) +author info </dd> -<dt><i>size</i></dt> +<dt><i>size</i> (int)</dt> <dd> -size info (integer) +size info </dd> -<dt><i>date</i></dt> +<dt><i>date</i> (int)</dt> <dd> -date info (integer) +date info </dd> -<dt><i>nodekind</i></dt> +<dt><i>nodekind</i> (pysvn.node_kind)</dt> <dd> -node kind info (pysvn.node_kind) +node kind info </dd> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -url of the entry (string) +url of the entry </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the generated item (QTreeWidgetItem) +reference to the generated item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem </dd> </dl> <a NAME="SvnRepoBrowserDialog.__listRepo" ID="SvnRepoBrowserDialog.__listRepo"></a> @@ -197,14 +202,13 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -the repository URL to browser (string) +the repository URL to browser </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt> <dd> reference to the item, the data should be appended to - (QTreeWidget or QTreeWidgetItem) </dd> </dl> <a NAME="SvnRepoBrowserDialog.__normalizeUrl" ID="SvnRepoBrowserDialog.__normalizeUrl"></a> @@ -216,15 +220,21 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -the url to normalize (string) +the url to normalize </dd> </dl> <dl> <dt>Return:</dt> <dd> -normalized URL (string) +normalized URL +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnRepoBrowserDialog.__resizeColumns" ID="SvnRepoBrowserDialog.__resizeColumns"></a> @@ -250,9 +260,9 @@ </p> <dl> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -error message to show (string) +error message to show </dd> </dl> <a NAME="SvnRepoBrowserDialog.accept" ID="SvnRepoBrowserDialog.accept"></a> @@ -272,7 +282,13 @@ <dl> <dt>Return:</dt> <dd> -the selected repository URL (string) +the selected repository URL +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnRepoBrowserDialog.on_repoTree_itemCollapsed" ID="SvnRepoBrowserDialog.on_repoTree_itemCollapsed"></a> @@ -284,9 +300,9 @@ </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QTreeWidgetItem)</dt> <dd> -reference to the item to be collapsed (QTreeWidgetItem) +reference to the item to be collapsed </dd> </dl> <a NAME="SvnRepoBrowserDialog.on_repoTree_itemExpanded" ID="SvnRepoBrowserDialog.on_repoTree_itemExpanded"></a> @@ -298,9 +314,9 @@ </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QTreeWidgetItem)</dt> <dd> -reference to the item to be expanded (QTreeWidgetItem) +reference to the item to be expanded </dd> </dl> <a NAME="SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged" ID="SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged"></a> @@ -333,9 +349,9 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -the repository URL to browser (string) +the repository URL to browser </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnRevisionSelectionDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnRevisionSelectionDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -83,9 +83,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of the dialog (QWidget) +parent widget of the dialog </dd> </dl> <a NAME="SvnRevisionSelectionDialog.__getRevision" ID="SvnRevisionSelectionDialog.__getRevision"></a> @@ -97,7 +97,7 @@ </p> <dl> -<dt><i>no</i></dt> +<dt><i>no</i> (int)</dt> <dd> revision number to generate (1 or 2) </dd> @@ -105,7 +105,13 @@ <dl> <dt>Return:</dt> <dd> -revision (integer or string) +revision +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int or str </dd> </dl> <a NAME="SvnRevisionSelectionDialog.getRevisions" ID="SvnRevisionSelectionDialog.getRevisions"></a> @@ -118,7 +124,13 @@ <dl> <dt>Return:</dt> <dd> -list two integers or strings +list containing the selected revisions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of [int or str, int or str] </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnStatusDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnStatusDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -138,7 +138,7 @@ </tr> <tr> <td><a href="#SvnStatusDialog.__removeFromChangelist">__removeFromChangelist</a></td> -<td>Private slot to remove entries from their changelists.</td> +<td>Private slot to remove entries from their change lists.</td> </tr> <tr> <td><a href="#SvnStatusDialog.__resizeColumns">__resizeColumns</a></td> @@ -248,13 +248,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnStatusDialog.__add" ID="SvnStatusDialog.__add"></a> @@ -301,9 +301,9 @@ </p> <dl> -<dt><i>selected</i></dt> +<dt><i>selected</i> (bool)</dt> <dd> -commit selection state to be set (boolean) +commit selection state to be set </dd> </dl> <a NAME="SvnStatusDialog.__commitSelectAll" ID="SvnStatusDialog.__commitSelectAll"></a> @@ -344,53 +344,53 @@ </p> <dl> -<dt><i>changelist</i></dt> +<dt><i>changelist</i> (str)</dt> <dd> -name of the changelist (string) +name of the changelist </dd> -<dt><i>status</i></dt> +<dt><i>status</i> (pysvn.wc_status_kind)</dt> <dd> -text status (pysvn.wc_status_kind) +text status </dd> -<dt><i>propStatus</i></dt> +<dt><i>propStatus</i> (pysvn.wc_status_kind)</dt> <dd> -property status (pysvn.wc_status_kind) +property status </dd> -<dt><i>locked</i></dt> +<dt><i>locked</i> (bool)</dt> <dd> -locked flag (boolean) +locked flag </dd> -<dt><i>history</i></dt> +<dt><i>history</i> (bool)</dt> <dd> -history flag (boolean) +history flag </dd> -<dt><i>switched</i></dt> +<dt><i>switched</i> (bool)</dt> <dd> -switched flag (boolean) +switched flag </dd> -<dt><i>lockinfo</i></dt> +<dt><i>lockinfo</i> (str)</dt> <dd> -lock indicator (string) +lock indicator </dd> -<dt><i>uptodate</i></dt> +<dt><i>uptodate</i> (bool)</dt> <dd> -up to date flag (boolean) +up to date flag </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (int)</dt> <dd> -revision (integer) +revision </dd> -<dt><i>change</i></dt> +<dt><i>change</i> (int)</dt> <dd> -revision of last change (integer) +revision of last change </dd> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author of the last change (string) +author of the last change </dd> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -path of the file or directory (string) +path of the file or directory </dd> </dl> <a NAME="SvnStatusDialog.__getChangelistItems" ID="SvnStatusDialog.__getChangelistItems"></a> @@ -407,6 +407,12 @@ list of all items belonging to a changelist </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getCommitableItems" ID="SvnStatusDialog.__getCommitableItems"></a> <h4>SvnStatusDialog.__getCommitableItems</h4> <b>__getCommitableItems</b>(<i></i>) @@ -420,6 +426,12 @@ list of all items, the user has checked </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getLockActionItems" ID="SvnStatusDialog.__getLockActionItems"></a> <h4>SvnStatusDialog.__getLockActionItems</h4> <b>__getLockActionItems</b>(<i>indicators</i>) @@ -429,9 +441,9 @@ </p> <dl> -<dt><i>indicators</i></dt> +<dt><i>indicators</i> (list of str)</dt> <dd> -list of indicators to check against (list of strings) +list of indicators to check against </dd> </dl> <dl> @@ -440,6 +452,12 @@ list of all items with a locked status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getMissingItems" ID="SvnStatusDialog.__getMissingItems"></a> <h4>SvnStatusDialog.__getMissingItems</h4> <b>__getMissingItems</b>(<i></i>) @@ -453,6 +471,12 @@ list of all items with a missing status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getModifiedItems" ID="SvnStatusDialog.__getModifiedItems"></a> <h4>SvnStatusDialog.__getModifiedItems</h4> <b>__getModifiedItems</b>(<i></i>) @@ -466,6 +490,12 @@ list of all items with a modified status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getNonChangelistItems" ID="SvnStatusDialog.__getNonChangelistItems"></a> <h4>SvnStatusDialog.__getNonChangelistItems</h4> <b>__getNonChangelistItems</b>(<i></i>) @@ -480,6 +510,12 @@ list of all items not belonging to a changelist </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getUnversionedItems" ID="SvnStatusDialog.__getUnversionedItems"></a> <h4>SvnStatusDialog.__getUnversionedItems</h4> <b>__getUnversionedItems</b>(<i></i>) @@ -494,6 +530,12 @@ list of all items with an unversioned status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__lock" ID="SvnStatusDialog.__lock"></a> <h4>SvnStatusDialog.__lock</h4> <b>__lock</b>(<i></i>) @@ -506,7 +548,7 @@ <b>__removeFromChangelist</b>(<i></i>) <p> - Private slot to remove entries from their changelists. + Private slot to remove entries from their change lists. </p> <a NAME="SvnStatusDialog.__resizeColumns" ID="SvnStatusDialog.__resizeColumns"></a> <h4>SvnStatusDialog.__resizeColumns</h4> @@ -552,9 +594,9 @@ </p> <dl> -<dt><i>coord</i></dt> +<dt><i>coord</i> (QPoint)</dt> <dd> -the position of the mouse pointer (QPoint) +the position of the mouse pointer </dd> </dl> <a NAME="SvnStatusDialog.__showError" ID="SvnStatusDialog.__showError"></a> @@ -566,9 +608,9 @@ </p> <dl> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -error message to show (string) +error message to show </dd> </dl> <a NAME="SvnStatusDialog.__stealLock" ID="SvnStatusDialog.__stealLock"></a> @@ -615,9 +657,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnStatusDialog.on_commitButton_clicked" ID="SvnStatusDialog.on_commitButton_clicked"></a> @@ -685,13 +727,13 @@ </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QTreeWidgetItem)</dt> <dd> -reference to the changed item (QTreeWidgetItem) +reference to the changed item </dd> -<dt><i>column</i></dt> +<dt><i>column</i> (int)</dt> <dd> -index of column that changed (integer) +index of column that changed </dd> </dl> <a NAME="SvnStatusDialog.on_statusList_itemSelectionChanged" ID="SvnStatusDialog.on_statusList_itemSelectionChanged"></a> @@ -710,10 +752,9 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str or list of str)</dt> <dd> filename(s)/directoryname(s) to show the status of - (string or list of strings) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnStatusMonitorThread.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnStatusMonitorThread.html Sat Dec 23 15:40:23 2023 +0100 @@ -86,21 +86,21 @@ </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 (Project) +reference to the project object </dd> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the version control object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QObject)</dt> <dd> -reference to the parent object (QObject) +reference to the parent object </dd> </dl> <a NAME="SvnStatusMonitorThread.__clientLoginCallback" ID="SvnStatusMonitorThread.__clientLoginCallback"></a> @@ -120,6 +120,12 @@ password should be saved. Always returns (False, "", "", False). </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str, str, bool) +</dd> +</dl> <a NAME="SvnStatusMonitorThread.__clientSslServerTrustPromptCallback" ID="SvnStatusMonitorThread.__clientSslServerTrustPromptCallback"></a> <h4>SvnStatusMonitorThread.__clientSslServerTrustPromptCallback</h4> <b>__clientSslServerTrustPromptCallback</b>(<i></i>) @@ -138,6 +144,12 @@ Always returns (False, 0, False). </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, int, bool) +</dd> +</dl> <a NAME="SvnStatusMonitorThread._performMonitor" ID="SvnStatusMonitorThread._performMonitor"></a> <h4>SvnStatusMonitorThread._performMonitor</h4> <b>_performMonitor</b>(<i></i>) @@ -165,8 +177,14 @@ <dl> <dt>Return:</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> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnSwitchDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnSwitchDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,22 +78,21 @@ </p> <dl> -<dt><i>taglist</i></dt> +<dt><i>taglist</i> (list of str)</dt> <dd> -list of previously entered tags (list of strings) +list of previously entered tags </dd> -<dt><i>reposURL</i></dt> +<dt><i>reposURL</i> (str)</dt> <dd> -repository path (string) or None +repository path or None </dd> -<dt><i>standardLayout</i></dt> +<dt><i>standardLayout</i> (bool)</dt> <dd> -flag indicating the layout of the - repository (boolean) +flag indicating the layout of the repository </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnSwitchDialog.getParameters" ID="SvnSwitchDialog.getParameters"></a> @@ -106,7 +105,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of string and int (tag, tag type) +tuple containing the tag and tag type +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, int) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnTagBranchListDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnTagBranchListDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -106,13 +106,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnTagBranchListDialog.__finish" ID="SvnTagBranchListDialog.__finish"></a> @@ -132,21 +132,21 @@ </p> <dl> -<dt><i>revision</i></dt> +<dt><i>revision</i> (int)</dt> <dd> -revision number (integer) +revision number </dd> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author of the tag (string) +author of the tag </dd> -<dt><i>date</i></dt> +<dt><i>date</i> (str)</dt> <dd> -date of the tag (string) +date of the tag </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name (path) of the tag (string) +name (path) of the tag </dd> </dl> <a NAME="SvnTagBranchListDialog.__resizeColumns" ID="SvnTagBranchListDialog.__resizeColumns"></a> @@ -172,9 +172,9 @@ </p> <dl> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -error message to show (string) +error message to show </dd> </dl> <a NAME="SvnTagBranchListDialog.getTagList" ID="SvnTagBranchListDialog.getTagList"></a> @@ -187,7 +187,13 @@ <dl> <dt>Return:</dt> <dd> -list of tags (list of strings) +list of tags +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="SvnTagBranchListDialog.on_buttonBox_clicked" ID="SvnTagBranchListDialog.on_buttonBox_clicked"></a> @@ -199,9 +205,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnTagBranchListDialog.start" ID="SvnTagBranchListDialog.start"></a> @@ -213,20 +219,26 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -name of directory to be listed (string) +name of directory to be listed </dd> -<dt><i>tags</i></dt> +<dt><i>tags</i> (bool)</dt> <dd> flag indicating a list of tags is requested - (False = branches, True = tags) + (False = branches, True = tags) </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> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnTagDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnTagDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -82,22 +82,22 @@ </p> <dl> -<dt><i>taglist</i></dt> +<dt><i>taglist</i> (list of str)</dt> <dd> -list of previously entered tags (list of strings) +list of previously entered tags </dd> -<dt><i>reposURL</i></dt> +<dt><i>reposURL</i> (str)</dt> <dd> -repository path (string) or None +repository path or None </dd> -<dt><i>standardLayout</i></dt> +<dt><i>standardLayout</i> (bool)</dt> <dd> flag indicating the layout of the - repository (boolean) + repository </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnTagDialog.getParameters" ID="SvnTagDialog.getParameters"></a> @@ -110,7 +110,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of string and int (tag, tag operation) +tuple containing the tag and tag operation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, int </dd> </dl> <a NAME="SvnTagDialog.on_tagCombo_editTextChanged" ID="SvnTagDialog.on_tagCombo_editTextChanged"></a> @@ -122,9 +128,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -tag name entered in the combo (string) +tag name entered in the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnUrlSelectionDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnUrlSelectionDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,25 +90,25 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>tagsList</i></dt> +<dt><i>tagsList</i> (list of str)</dt> <dd> -list of tags (list of strings) +list of tags </dd> -<dt><i>branchesList</i></dt> +<dt><i>branchesList</i> (list of str)</dt> <dd> -list of branches (list of strings) +list of branches </dd> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -pathname to determine the repository URL from (string) +pathname to determine the repository URL from </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of the dialog (QWidget) +parent widget of the dialog </dd> </dl> <a NAME="SvnUrlSelectionDialog.__changeLabelCombo" ID="SvnUrlSelectionDialog.__changeLabelCombo"></a> @@ -121,13 +121,13 @@ </p> <dl> -<dt><i>labelCombo</i></dt> +<dt><i>labelCombo</i> (QComboBox)</dt> <dd> -reference to the labelCombo object (QComboBox) +reference to the labelCombo object </dd> -<dt><i>type_</i></dt> +<dt><i>type_</i> (str)</dt> <dd> -type string (string) +type string </dd> </dl> <a NAME="SvnUrlSelectionDialog.getURLs" ID="SvnUrlSelectionDialog.getURLs"></a> @@ -140,8 +140,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of list of two URL strings (list of strings) and - a flag indicating a diff summary (boolean) +tuple of list of two URL strings and a flag indicating a diff summary +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of [str, str], bool) </dd> </dl> <a NAME="SvnUrlSelectionDialog.on_typeCombo1_currentIndexChanged" ID="SvnUrlSelectionDialog.on_typeCombo1_currentIndexChanged"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnUtilities.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnUtilities.html Sat Dec 23 15:40:23 2023 +0100 @@ -81,15 +81,21 @@ </p> <dl> -<dt><i>seconds</i></dt> +<dt><i>seconds</i> (float or int)</dt> <dd> -time in seconds since epoch to be formatted (float or long) +time in seconds since epoch to be formatted </dd> </dl> <dl> <dt>Return:</dt> <dd> -date (QDate) +date +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QDate </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -104,15 +110,21 @@ </p> <dl> -<dt><i>seconds</i></dt> +<dt><i>seconds</i> (float or int)</dt> <dd> -time in seconds since epoch to be formatted (float or long) +time in seconds since epoch to be formatted </dd> </dl> <dl> <dt>Return:</dt> <dd> -formatted time string (string) +formatted time string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -128,7 +140,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the config file (string) +filename of the config file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -144,7 +162,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the servers file (string) +filename of the servers file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html Sat Dec 23 15:40:23 2023 +0100 @@ -362,17 +362,17 @@ </p> <dl> -<dt><i>plugin</i></dt> +<dt><i>plugin</i> (VcsSubversionPlugin)</dt> <dd> reference to the plugin object </dd> -<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="Subversion.__isVersioned" ID="Subversion.__isVersioned"></a> @@ -385,15 +385,21 @@ </p> <dl> -<dt><i>status</i></dt> +<dt><i>status</i> (pysvn.PysvnStatus)</dt> <dd> -status object to check (pysvn.PysvnStatus) +status object to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a versioned state (boolean) +flag indicating a versioned state +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Subversion.__svnGetFileForRevision" ID="Subversion.__svnGetFileForRevision"></a> @@ -406,19 +412,25 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file name to get from the repository (string) +file name to get from the repository </dd> -<dt><i>rev</i></dt> +<dt><i>rev</i> (int or str)</dt> <dd> -revision to retrieve (integer or string) +revision to retrieve </dd> </dl> <dl> <dt>Return:</dt> <dd> -contents of the file (string) and an error message (string) +contents of the file (string) and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a> @@ -430,15 +442,21 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -unformatted url string (string) +unformatted url string </dd> </dl> <dl> <dt>Return:</dt> <dd> -properly formated url for subversion (string) +properly formated url for subversion +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Subversion.__vcsAllRegisteredStates_wc" ID="Subversion.__vcsAllRegisteredStates_wc"></a> @@ -460,17 +478,17 @@ </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> -<dt><i>shortcut</i></dt> +<dt><i>shortcut</i> (bool)</dt> <dd> -flag indicating a shortcut should be taken (boolean) +flag indicating a shortcut should be taken </dd> </dl> <dl> @@ -480,6 +498,12 @@ canBeCommited and canBeAdded or None in order to signal an error </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="Subversion.__vcsAllRegisteredStates_wcng" ID="Subversion.__vcsAllRegisteredStates_wcng"></a> <h4>Subversion.__vcsAllRegisteredStates_wcng</h4> <b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname, shortcut=True</i>) @@ -499,17 +523,17 @@ </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> -<dt><i>shortcut</i></dt> +<dt><i>shortcut</i> (bool)</dt> <dd> -flag indicating a shortcut should be taken (boolean) +flag indicating a shortcut should be taken </dd> </dl> <dl> @@ -519,6 +543,12 @@ canBeCommited and canBeAdded or None in order to signal an error </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a> <h4>Subversion.__vcsCommit_Step2</h4> <b>__vcsCommit_Step2</b>(<i></i>) @@ -539,15 +569,21 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -filename to check (string) +filename to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -a combination of canBeCommited and canBeAdded +registered state (one of canBeCommited and canBeAdded) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Subversion.__vcsRegisteredState_wcng" ID="Subversion.__vcsRegisteredState_wcng"></a> @@ -563,15 +599,21 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -filename to check (string) +filename to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -a combination of canBeCommited and canBeAdded +registered state (one of canBeCommited and canBeAdded) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Subversion._createStatusMonitorThread" ID="Subversion._createStatusMonitorThread"></a> @@ -584,12 +626,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> @@ -597,7 +638,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> +SvnStatusMonitorThread </dd> </dl> <a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a> @@ -617,7 +664,13 @@ <dl> <dt>Return:</dt> <dd> -the pysvn client object (pysvn.Client) +the pysvn client object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +pysvn.Client </dd> </dl> <a NAME="Subversion.getPlugin" ID="Subversion.getPlugin"></a> @@ -630,7 +683,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the plugin object (VcsPySvnPlugin) +reference to the plugin object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +VcsPySvnPlugin </dd> </dl> <a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a> @@ -645,10 +704,9 @@ </p> <dl> -<dt><i>names</i></dt> +<dt><i>names</i> (str or list of str)</dt> <dd> name or list of names of file or directory to add - (string) </dd> </dl> <a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a> @@ -660,9 +718,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file name to show the blame for (string) +file name to show the blame for </dd> </dl> <a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a> @@ -674,11 +732,11 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name to be copied (string) +file/directory name to be copied </dd> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> @@ -686,7 +744,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> <a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a> @@ -698,11 +762,11 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name (string or list of strings) +file/directory name </dd> -<dt><i>recursive</i></dt> +<dt><i>recursive</i> (bool)</dt> <dd> flag indicating a recursive list is requested </dd> @@ -726,9 +790,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> <a NAME="Subversion.svnGetChangelists" ID="Subversion.svnGetChangelists"></a> @@ -741,7 +805,13 @@ <dl> <dt>Return:</dt> <dd> -list of defined change list names (list of strings) +list of defined change list names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a> @@ -754,9 +824,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -local path to get the svn repository path for (string) +local path to get the svn repository path for </dd> </dl> <dl> @@ -765,6 +835,12 @@ string with the repository path URL </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="Subversion.svnInfo" ID="Subversion.svnInfo"></a> <h4>Subversion.svnInfo</h4> <b>svnInfo</b>(<i>projectPath, name</i>) @@ -774,13 +850,13 @@ </p> <dl> -<dt><i>projectPath</i></dt> +<dt><i>projectPath</i> (str)</dt> <dd> -path name of the project (string) +path name of the project </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name relative to the project (string) +file/directory name relative to the project </dd> </dl> <a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a> @@ -792,11 +868,11 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name (string or list of strings) +file/directory name </dd> -<dt><i>recursive</i></dt> +<dt><i>recursive</i> (bool)</dt> <dd> flag indicating a recursive list is requested </dd> @@ -810,11 +886,11 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -directory name of the project (string) +directory name of the project </dd> -<dt><i>tags</i></dt> +<dt><i>tags</i> (bool)</dt> <dd> flag indicating listing of branches or tags (False = branches, True = tags) @@ -829,19 +905,17 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be locked (string or list of - strings) +file/directory name to be locked </dd> -<dt><i>stealIt</i></dt> +<dt><i>stealIt</i> (bool)</dt> <dd> -flag indicating a forced operation (boolean) +flag indicating a forced operation </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent object of the subversion dialog - (QWidget) </dd> </dl> <a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a> @@ -853,15 +927,21 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -url string (string) +url string </dd> </dl> <dl> <dt>Return:</dt> <dd> -properly normalized url for subversion (string) +properly normalized url for subversion +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a> @@ -873,9 +953,9 @@ </p> <dl> -<dt><i>projectPath</i></dt> +<dt><i>projectPath</i> (str)</dt> <dd> -path name of the project (string) +path name of the project </dd> </dl> <a NAME="Subversion.svnRemoveFromChangelist" ID="Subversion.svnRemoveFromChangelist"></a> @@ -890,10 +970,9 @@ </p> <dl> -<dt><i>names</i></dt> +<dt><i>names</i> (str or list of str)</dt> <dd> name or list of names of file or directory to remove - (string) </dd> </dl> <a NAME="Subversion.svnRepoBrowser" ID="Subversion.svnRepoBrowser"></a> @@ -905,9 +984,9 @@ </p> <dl> -<dt><i>projectPath</i></dt> +<dt><i>projectPath</i> (str)</dt> <dd> -path name of the project (string) +path name of the project </dd> </dl> <a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a> @@ -919,11 +998,11 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name (string or list of strings) +file/directory name </dd> -<dt><i>recursive</i></dt> +<dt><i>recursive</i> (bool)</dt> <dd> flag indicating a recursive set is requested </dd> @@ -937,9 +1016,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -directory name to show change lists for (string) +directory name to show change lists for </dd> </dl> <a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a> @@ -951,19 +1030,17 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be unlocked (string or list of - strings) +file/directory name to be unlocked </dd> -<dt><i>breakIt</i></dt> +<dt><i>breakIt</i> (bool)</dt> <dd> -flag indicating a forced operation (boolean) +flag indicating a forced operation </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent object of the subversion dialog - (QWidget) </dd> </dl> <a NAME="Subversion.svnUpgrade" ID="Subversion.svnUpgrade"></a> @@ -975,9 +1052,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -directory name to show change lists for (string) +directory name to show change lists for </dd> </dl> <a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a> @@ -999,9 +1076,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> <a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a> @@ -1014,17 +1091,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> <a NAME="Subversion.vcsAddBinary" ID="Subversion.vcsAddBinary"></a> @@ -1037,13 +1114,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> <a NAME="Subversion.vcsAddCommitMessage" ID="Subversion.vcsAddCommitMessage"></a> @@ -1070,10 +1147,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str or list of str)</dt> <dd> -root directory of the tree to be added (string or list of - strings)) +root directory of the tree to be added </dd> </dl> <a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a> @@ -1091,17 +1167,17 @@ </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> -<dt><i>shortcut</i></dt> +<dt><i>shortcut</i> (bool)</dt> <dd> -flag indicating a shortcut should be taken (boolean) +flag indicating a shortcut should be taken </dd> </dl> <dl> @@ -1111,6 +1187,12 @@ canBeCommited and canBeAdded or None in order to signal an error </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a> <h4>Subversion.vcsCheckout</h4> <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) @@ -1121,15 +1203,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> @@ -1137,7 +1219,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> <a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a> @@ -1149,9 +1237,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> <a NAME="Subversion.vcsClearCommitMessages" ID="Subversion.vcsClearCommitMessages"></a> @@ -1170,9 +1258,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> <a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a> @@ -1185,16 +1273,15 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be committed (string or - list of strings) +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 </dd> @@ -1257,9 +1344,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> <a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a> @@ -1272,8 +1359,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the existance (boolean) and an error message - (string) +flag indicating the existance and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) </dd> </dl> <a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a> @@ -1286,19 +1378,25 @@ </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> </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> <a NAME="Subversion.vcsForget" ID="Subversion.vcsForget"></a> @@ -1329,15 +1427,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) @@ -1349,6 +1447,12 @@ the project browser helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +SvnProjectBrowserHelper +</dd> +</dl> <a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a> <h4>Subversion.vcsGetProjectHelper</h4> <b>vcsGetProjectHelper</b>(<i>project</i>) @@ -1358,7 +1462,7 @@ </p> <dl> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> @@ -1369,6 +1473,12 @@ the project helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +PySvnProjectHelper +</dd> +</dl> <a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a> <h4>Subversion.vcsImport</h4> <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) @@ -1385,7 +1495,7 @@ </dd> <dt><i>projectDir</i> (str)</dt> <dd> -project directory (string) +project directory </dd> <dt><i>noDialog</i> (bool)</dt> <dd> @@ -1423,19 +1533,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> -always TRUE +always True +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a> @@ -1451,9 +1567,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="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a> @@ -1466,13 +1582,13 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name to show the log of (string) +file/directory name to show the log of </dd> -<dt><i>isFile</i></dt> +<dt><i>isFile</i> (bool)</dt> <dd> -flag indicating log for a file is to be shown (boolean) +flag indicating log for a file is to be shown </dd> </dl> <a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a> @@ -1484,9 +1600,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> <a NAME="Subversion.vcsMove" ID="Subversion.vcsMove"></a> @@ -1498,19 +1614,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> @@ -1518,7 +1634,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> <a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a> @@ -1531,7 +1653,13 @@ <dl> <dt>Return:</dt> <dd> -always 'Subversion' (string) +always 'Subversion' +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a> @@ -1544,16 +1672,21 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <dl> <dt>Return:</dt> <dd> reference to the instantiated options dialog - (SvnNewProjectOptionsDialog) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +SvnNewProjectOptionsDialog </dd> </dl> <a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a> @@ -1565,28 +1698,33 @@ </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> <dt>Return:</dt> <dd> -reference to the instantiated options dialog (SvnOptionsDialog) +reference to the instantiated options dialog +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +SvnOptionsDialog </dd> </dl> <a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a> @@ -1598,15 +1736,21 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -filename to check (string) +filename to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -a combination of canBeCommited and canBeAdded +registered state (one of canBeCommited and canBeAdded) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a> @@ -1622,17 +1766,15 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be removed (string or list of - strings)) +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) - (not needed) +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> @@ -1640,7 +1782,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> <a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a> @@ -1652,15 +1800,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> <a NAME="Subversion.vcsResolved" ID="Subversion.vcsResolved"></a> @@ -1672,9 +1826,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name to be resolved (string) +file/directory name to be resolved </dd> </dl> <a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a> @@ -1714,17 +1868,17 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file name to be diffed (string) +file name to be diffed </dd> -<dt><i>extended</i></dt> +<dt><i>extended</i> (bool)</dt> <dd> -flag indicating the extended variant (boolean) +flag indicating the extended variant </dd> -<dt><i>revisions</i></dt> +<dt><i>revisions</i> (tuple of (str, str))</dt> <dd> -tuple of two revisions (tuple of strings) +tuple of two revisions </dd> </dl> <dl> @@ -1751,10 +1905,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> file/directory name(s) to show the status of - (string or list of strings) </dd> </dl> <a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a> @@ -1766,16 +1919,21 @@ </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) +flag indicating, that the switch contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a> @@ -1788,9 +1946,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> <a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a> @@ -1803,21 +1961,25 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> ((str or list of str)</dt> <dd> -file/directory name to be updated (string or list of - strings) +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) +flag indicating, that the update contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.ConfigurationPage.SubversionPage.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.ConfigurationPage.SubversionPage.html Sat Dec 23 15:40:23 2023 +0100 @@ -86,7 +86,7 @@ </p> <dl> -<dt><i>plugin</i></dt> +<dt><i>plugin</i> (VcsSubversionPlugin)</dt> <dd> reference to the plugin object </dd>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -186,30 +186,30 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>browserObject</i></dt> +<dt><i>browserObject</i> (ProjectBaseBrowser)</dt> <dd> reference to the project browser object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</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) </dd> -<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="SvnProjectBrowserHelper.__SVNAddToChangelist" ID="SvnProjectBrowserHelper.__SVNAddToChangelist"></a> @@ -368,15 +368,21 @@ </p> <dl> -<dt><i>items</i></dt> +<dt><i>items</i> (list of QTreeWidgetItems)</dt> <dd> -items to check (list of QTreeWidgetItems) +items to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating items contain file type items (boolean) +flag indicating items contain file type items +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="SvnProjectBrowserHelper._addVCSMenu" ID="SvnProjectBrowserHelper._addVCSMenu"></a> @@ -388,7 +394,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -402,7 +408,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -416,7 +422,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -430,7 +436,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -445,7 +451,7 @@ </p> <dl> -<dt><i>mainMenu</i></dt> +<dt><i>mainMenu</i> (QMenu)</dt> <dd> reference to the menu to be amended </dd> @@ -463,11 +469,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -486,11 +492,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -509,11 +515,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -533,11 +539,11 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i></dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.ProjectHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.ProjectHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -146,21 +146,21 @@ </p> <dl> -<dt><i>vcsObject</i></dt> +<dt><i>vcsObject</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>projectObject</i></dt> +<dt><i>projectObject</i> (Project)</dt> <dd> reference to the project object </dd> -<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="SvnProjectHelper.__svnBranchList" ID="SvnProjectHelper.__svnBranchList"></a> @@ -266,7 +266,13 @@ <dl> <dt>Return:</dt> <dd> -list of all actions (list of EricAction) +list of all actions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of EricAction </dd> </dl> <a NAME="SvnProjectHelper.initActions" ID="SvnProjectHelper.initActions"></a> @@ -285,9 +291,9 @@ </p> <dl> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu to be populated (QMenu) +reference to the menu to be populated </dd> </dl> <a NAME="SvnProjectHelper.initToolbar" ID="SvnProjectHelper.initToolbar"></a> @@ -299,14 +305,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <a NAME="SvnProjectHelper.removeToolbar" ID="SvnProjectHelper.removeToolbar"></a> @@ -318,14 +323,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnBlameDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -126,13 +126,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnBlameDialog.__finish" ID="SvnBlameDialog.__finish"></a> @@ -152,17 +152,17 @@ </p> <dl> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision string (string) +revision string </dd> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author of the change (string) +author of the change </dd> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -line of text from the annotated file (string) +line of text from the annotated file </dd> </dl> <a NAME="SvnBlameDialog.__procFinished" ID="SvnBlameDialog.__procFinished"></a> @@ -174,13 +174,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="SvnBlameDialog.__readStderr" ID="SvnBlameDialog.__readStderr"></a> @@ -221,9 +221,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="SvnBlameDialog.keyPressEvent" ID="SvnBlameDialog.keyPressEvent"></a> @@ -235,9 +235,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="SvnBlameDialog.on_buttonBox_clicked" ID="SvnBlameDialog.on_buttonBox_clicked"></a> @@ -249,9 +249,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnBlameDialog.on_input_returnPressed" ID="SvnBlameDialog.on_input_returnPressed"></a> @@ -270,9 +270,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="SvnBlameDialog.on_sendButton_clicked" ID="SvnBlameDialog.on_sendButton_clicked"></a> @@ -291,9 +291,9 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to show the blame for (string) +filename to show the blame for </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnChangeListsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnChangeListsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -118,13 +118,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnChangeListsDialog.__finish" ID="SvnChangeListsDialog.__finish"></a> @@ -144,13 +144,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="SvnChangeListsDialog.__readStderr" ID="SvnChangeListsDialog.__readStderr"></a> @@ -184,9 +184,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="SvnChangeListsDialog.on_buttonBox_clicked" ID="SvnChangeListsDialog.on_buttonBox_clicked"></a> @@ -198,9 +198,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnChangeListsDialog.on_changeLists_currentItemChanged" ID="SvnChangeListsDialog.on_changeLists_currentItemChanged"></a> @@ -212,13 +212,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QListWidgetItem)</dt> <dd> -current item (QListWidgetItem) +current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QListWidgetItem)</dt> <dd> -previous current item (QListWidgetItem) +previous current item </dd> </dl> <a NAME="SvnChangeListsDialog.on_input_returnPressed" ID="SvnChangeListsDialog.on_input_returnPressed"></a> @@ -237,9 +237,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="SvnChangeListsDialog.on_sendButton_clicked" ID="SvnChangeListsDialog.on_sendButton_clicked"></a> @@ -258,9 +258,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -directory name to show change lists for (string) +directory name to show change lists for </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnCommandDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnCommandDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -87,21 +87,21 @@ </p> <dl> -<dt><i>argvList</i></dt> +<dt><i>argvList</i> (list of str)</dt> <dd> -history list of commandline arguments (list of strings) +history list of commandline arguments </dd> -<dt><i>wdList</i></dt> +<dt><i>wdList</i> (list of str)</dt> <dd> -history list of working directories (list of strings) +history list of working directories </dd> -<dt><i>ppath</i></dt> +<dt><i>ppath</i> (str)</dt> <dd> -pathname of the project directory (string) +pathname of the project directory </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of this dialog (QWidget) +parent widget of this dialog </dd> </dl> <a NAME="SvnCommandDialog.getData" ID="SvnCommandDialog.getData"></a> @@ -114,7 +114,13 @@ <dl> <dt>Return:</dt> <dd> -a tuple of argv, workdir +tuple cotaining the command line arguments and the working directory +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) </dd> </dl> <a NAME="SvnCommandDialog.on_commandCombo_editTextChanged" ID="SvnCommandDialog.on_commandCombo_editTextChanged"></a> @@ -126,9 +132,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -ignored +text of the command combobox </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -72,11 +72,11 @@ </tr> <tr> <td><a href="#SvnCommitDialog.changelistsData">changelistsData</a></td> -<td>Public method to retrieve the changelists data.</td> +<td>Public method to retrieve the change lists data.</td> </tr> <tr> <td><a href="#SvnCommitDialog.hasChangelists">hasChangelists</a></td> -<td>Public method to check, if the user entered some changelists.</td> +<td>Public method to check, if the user entered some change lists.</td> </tr> <tr> <td><a href="#SvnCommitDialog.logMessage">logMessage</a></td> @@ -118,13 +118,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnCommitDialog.changelistsData" ID="SvnCommitDialog.changelistsData"></a> @@ -132,13 +132,19 @@ <b>changelistsData</b>(<i></i>) <p> - Public method to retrieve the changelists data. + Public method to retrieve the change lists data. </p> <dl> <dt>Return:</dt> <dd> -tuple containing the changelists (list of strings) and a flag - indicating to keep changelists (boolean) +tuple containing the change lists and a flag indicating to keep + the change lists +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, bool) </dd> </dl> <a NAME="SvnCommitDialog.hasChangelists" ID="SvnCommitDialog.hasChangelists"></a> @@ -146,12 +152,18 @@ <b>hasChangelists</b>(<i></i>) <p> - Public method to check, if the user entered some changelists. + Public method to check, if the user entered some change lists. </p> <dl> <dt>Return:</dt> <dd> -flag indicating availability of changelists (boolean) +flag indicating availability of change lists +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="SvnCommitDialog.logMessage" ID="SvnCommitDialog.logMessage"></a> @@ -164,7 +176,13 @@ <dl> <dt>Return:</dt> <dd> -the log message (string) +the log message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnCommitDialog.on_buttonBox_accepted" ID="SvnCommitDialog.on_buttonBox_accepted"></a> @@ -183,9 +201,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnCommitDialog.on_buttonBox_rejected" ID="SvnCommitDialog.on_buttonBox_rejected"></a> @@ -218,9 +236,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QShowEvent)</dt> <dd> -the event (QShowEvent) +the event </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnCopyDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnCopyDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -83,21 +83,21 @@ </p> <dl> -<dt><i>source</i></dt> +<dt><i>source</i> (str)</dt> <dd> -name of the source file/directory (string) +name of the source file/directory </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> -<dt><i>move</i></dt> +<dt><i>move</i> (bool)</dt> <dd> -flag indicating a move operation (boolean) +flag indicating a move operation </dd> -<dt><i>force</i></dt> +<dt><i>force</i> (bool)</dt> <dd> -flag indicating a forced operation (boolean) +flag indicating a forced operation </dd> </dl> <a NAME="SvnCopyDialog.getData" ID="SvnCopyDialog.getData"></a> @@ -110,8 +110,14 @@ <dl> <dt>Return:</dt> <dd> -the target name (string) and a flag indicating - the operation should be enforced (boolean) +tuple containing the target name and a flag indicating the + operation should be enforced +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) </dd> </dl> <a NAME="SvnCopyDialog.on_targetPicker_textChanged" ID="SvnCopyDialog.on_targetPicker_textChanged"></a> @@ -123,9 +129,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -contents of the target edit (string) +contents of the target edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -127,13 +127,13 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text to be shown by the label (string) +text to be shown by the label </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnDialog.__finish" ID="SvnDialog.__finish"></a> @@ -153,13 +153,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="SvnDialog.__readStderr" ID="SvnDialog.__readStderr"></a> @@ -194,7 +194,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of an add or delete (boolean) +flag indicating the presence of an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="SvnDialog.keyPressEvent" ID="SvnDialog.keyPressEvent"></a> @@ -206,9 +212,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="SvnDialog.normalExit" ID="SvnDialog.normalExit"></a> @@ -221,7 +227,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating normal process termination (boolean) +flag indicating normal process termination +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="SvnDialog.on_buttonBox_clicked" ID="SvnDialog.on_buttonBox_clicked"></a> @@ -233,9 +245,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnDialog.on_input_returnPressed" ID="SvnDialog.on_input_returnPressed"></a> @@ -254,9 +266,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="SvnDialog.on_sendButton_clicked" ID="SvnDialog.on_sendButton_clicked"></a> @@ -275,17 +287,17 @@ </p> <dl> -<dt><i>args</i></dt> +<dt><i>args</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> -<dt><i>setLanguage</i></dt> +<dt><i>setLanguage</i> (bool)</dt> <dd> -flag indicating to set the language to "C" (boolean) +flag indicating to set the language to "C" </dd> </dl> <dl> @@ -294,6 +306,12 @@ flag indicating a successful start of the process </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -144,13 +144,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a> @@ -162,9 +162,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text to insert (string) +text to insert </dd> </dl> <a NAME="SvnDiffDialog.__extractFileName" ID="SvnDiffDialog.__extractFileName"></a> @@ -176,15 +176,21 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -line to be processed (string) +line to be processed </dd> </dl> <dl> <dt>Return:</dt> <dd> -extracted file name (string) +extracted file name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a> @@ -196,15 +202,21 @@ </p> <dl> -<dt><i>version</i></dt> +<dt><i>version</i> (int or str)</dt> <dd> -revision (integer or string) +revision </dd> </dl> <dl> <dt>Return:</dt> <dd> -version argument (string) +version argument +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnDiffDialog.__procFinished" ID="SvnDiffDialog.__procFinished"></a> @@ -216,13 +228,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="SvnDiffDialog.__processFileLine" ID="SvnDiffDialog.__processFileLine"></a> @@ -234,9 +246,9 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -line to be processed (string) +line to be processed </dd> </dl> <a NAME="SvnDiffDialog.__readStderr" ID="SvnDiffDialog.__readStderr"></a> @@ -270,9 +282,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="SvnDiffDialog.keyPressEvent" ID="SvnDiffDialog.keyPressEvent"></a> @@ -284,9 +296,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a> @@ -298,9 +310,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnDiffDialog.on_filesCombo_activated" ID="SvnDiffDialog.on_filesCombo_activated"></a> @@ -312,9 +324,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -activated row (integer) +activated row </dd> </dl> <a NAME="SvnDiffDialog.on_input_returnPressed" ID="SvnDiffDialog.on_input_returnPressed"></a> @@ -333,9 +345,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="SvnDiffDialog.on_refreshButton_clicked" ID="SvnDiffDialog.on_refreshButton_clicked"></a> @@ -372,27 +384,26 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to be diffed (string) +filename to be diffed </dd> -<dt><i>versions</i></dt> +<dt><i>versions</i> (list of up to 2 str or None)</dt> <dd> -list of versions to be diffed (list of up to 2 strings - or None) +list of versions to be diffed </dd> -<dt><i>urls</i></dt> +<dt><i>urls</i> (list of [str, str])</dt> <dd> -list of repository URLs (list of 2 strings) +list of repository URLs </dd> -<dt><i>summary</i></dt> +<dt><i>summary</i> (bool)</dt> <dd> flag indicating a summarizing diff - (only valid for URL diffs) (boolean) + (only valid for URL diffs) </dd> -<dt><i>refreshable</i></dt> +<dt><i>refreshable</i> (bool)</dt> <dd> -flag indicating a refreshable diff (boolean) +flag indicating a refreshable diff </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDiffHighlighter.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDiffHighlighter.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,9 +78,9 @@ </p> <dl> -<dt><i>doc</i></dt> +<dt><i>doc</i> (QTextDocument)</dt> <dd> -reference to the text document (QTextDocument) +reference to the text document </dd> </dl> <a NAME="SvnDiffHighlighter.generateRules" ID="SvnDiffHighlighter.generateRules"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnLogBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnLogBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -222,13 +222,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnLogBrowserDialog.__addFinishCallback" ID="SvnLogBrowserDialog.__addFinishCallback"></a> @@ -258,13 +258,13 @@ </p> <dl> -<dt><i>rev1</i></dt> +<dt><i>rev1</i> (int)</dt> <dd> -first revision number (integer) +first revision number </dd> -<dt><i>rev2</i></dt> +<dt><i>rev2</i> (int)</dt> <dd> -second revision number (integer) +second revision number </dd> </dl> <a NAME="SvnLogBrowserDialog.__filterLogs" ID="SvnLogBrowserDialog.__filterLogs"></a> @@ -291,27 +291,33 @@ </p> <dl> -<dt><i>action</i></dt> +<dt><i>action</i> (str)</dt> <dd> indicator for the change action ("A", "D" or "M") </dd> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -path of the file in the repository (string) +path of the file in the repository </dd> -<dt><i>copyFrom</i></dt> +<dt><i>copyFrom</i> (str)</dt> <dd> -path the file was copied from (None, string) +path the file was copied from </dd> -<dt><i>copyRev</i></dt> +<dt><i>copyRev</i> (str)</dt> <dd> -revision the file was copied from (None, string) +revision the file was copied from </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the generated item (QTreeWidgetItem) +reference to the generated item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem </dd> </dl> <a NAME="SvnLogBrowserDialog.__generateLogItem" ID="SvnLogBrowserDialog.__generateLogItem"></a> @@ -323,23 +329,23 @@ </p> <dl> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author info (string) +author info </dd> -<dt><i>date</i></dt> +<dt><i>date</i> (str)</dt> <dd> -date info (string) +date info </dd> -<dt><i>message</i></dt> +<dt><i>message</i> (list of str)</dt> <dd> -text of the log message (list of strings) +text of the log message </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision info (string) +revision info </dd> -<dt><i>changedPaths</i></dt> +<dt><i>changedPaths</i> (dict)</dt> <dd> list of dictionary objects containing info about the changed files/directories @@ -348,7 +354,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the generated item (QTreeWidgetItem) +reference to the generated item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem </dd> </dl> <a NAME="SvnLogBrowserDialog.__getLogEntries" ID="SvnLogBrowserDialog.__getLogEntries"></a> @@ -360,9 +372,9 @@ </p> <dl> -<dt><i>startRev</i></dt> +<dt><i>startRev</i> (int or str)</dt> <dd> -revision number to start from (integer, string) +revision number to start from </dd> </dl> <a NAME="SvnLogBrowserDialog.__initData" ID="SvnLogBrowserDialog.__initData"></a> @@ -381,13 +393,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="SvnLogBrowserDialog.__processBuffer" ID="SvnLogBrowserDialog.__processBuffer"></a> @@ -462,9 +474,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="SvnLogBrowserDialog.keyPressEvent" ID="SvnLogBrowserDialog.keyPressEvent"></a> @@ -476,9 +488,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="SvnLogBrowserDialog.on_buttonBox_clicked" ID="SvnLogBrowserDialog.on_buttonBox_clicked"></a> @@ -490,9 +502,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnLogBrowserDialog.on_diffPreviousButton_clicked" ID="SvnLogBrowserDialog.on_diffPreviousButton_clicked"></a> @@ -539,9 +551,9 @@ </p> <dl> -<dt><i>date</i></dt> +<dt><i>date</i> (QDate)</dt> <dd> -new date (QDate) +new date </dd> </dl> <a NAME="SvnLogBrowserDialog.on_input_returnPressed" ID="SvnLogBrowserDialog.on_input_returnPressed"></a> @@ -560,13 +572,13 @@ </p> <dl> -<dt><i>current</i></dt> +<dt><i>current</i> (QTreeWidgetItem)</dt> <dd> -reference to the new current item (QTreeWidgetItem) +reference to the new current item </dd> -<dt><i>previous</i></dt> +<dt><i>previous</i> (QTreeWidgetItem)</dt> <dd> -reference to the old current item (QTreeWidgetItem) +reference to the old current item </dd> </dl> <a NAME="SvnLogBrowserDialog.on_logTree_itemSelectionChanged" ID="SvnLogBrowserDialog.on_logTree_itemSelectionChanged"></a> @@ -592,9 +604,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="SvnLogBrowserDialog.on_rxEdit_textChanged" ID="SvnLogBrowserDialog.on_rxEdit_textChanged"></a> @@ -606,9 +618,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -filter expression (string) +filter expression </dd> </dl> <a NAME="SvnLogBrowserDialog.on_sendButton_clicked" ID="SvnLogBrowserDialog.on_sendButton_clicked"></a> @@ -627,9 +639,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -flag indicating the checked state (boolean) +flag indicating the checked state </dd> </dl> <a NAME="SvnLogBrowserDialog.on_toDate_dateChanged" ID="SvnLogBrowserDialog.on_toDate_dateChanged"></a> @@ -641,9 +653,9 @@ </p> <dl> -<dt><i>date</i></dt> +<dt><i>date</i> (QDate)</dt> <dd> -new date (QDate) +new date </dd> </dl> <a NAME="SvnLogBrowserDialog.on_upButton_clicked" ID="SvnLogBrowserDialog.on_upButton_clicked"></a> @@ -669,14 +681,13 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename to show the log for (string) +filename 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> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnMergeDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnMergeDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,27 +90,25 @@ </p> <dl> -<dt><i>mergelist1</i></dt> +<dt><i>mergelist1</i> (list of str)</dt> <dd> list of previously entered URLs/revisions - (list of strings) </dd> -<dt><i>mergelist2</i></dt> +<dt><i>mergelist2</i> (list of str)</dt> <dd> list of previously entered URLs/revisions - (list of strings) </dd> -<dt><i>targetlist</i></dt> +<dt><i>targetlist</i> (list of str)</dt> <dd> -list of previously entered targets (list of strings) +list of previously entered targets </dd> -<dt><i>force</i></dt> +<dt><i>force</i> (bool)</dt> <dd> -flag indicating a forced merge (boolean) +flag indicating a forced merge </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnMergeDialog.__enableOkButton" ID="SvnMergeDialog.__enableOkButton"></a> @@ -131,7 +129,13 @@ <dt>Return:</dt> <dd> tuple naming two tag names or two revisions, a target and - a flag indicating a forced merge (string, string, string, boolean) + a flag indicating a forced merge +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, str, bool) </dd> </dl> <a NAME="SvnMergeDialog.on_tag1Combo_editTextChanged" ID="SvnMergeDialog.on_tag1Combo_editTextChanged"></a> @@ -143,9 +147,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <a NAME="SvnMergeDialog.on_tag2Combo_editTextChanged" ID="SvnMergeDialog.on_tag2Combo_editTextChanged"></a> @@ -157,9 +161,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text of the combo (string) +text of the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnNewProjectOptionsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnNewProjectOptionsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -100,13 +100,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the version control object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnNewProjectOptionsDialog.getData" ID="SvnNewProjectOptionsDialog.getData"></a> @@ -119,8 +119,14 @@ <dl> <dt>Return:</dt> <dd> -a tuple of a string (project directory) and a dictionary - containing the data entered. +tuple containing the (project directory and a dictionary containing + the data entered. +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, dict) </dd> </dl> <a NAME="SvnNewProjectOptionsDialog.on_layoutCheckBox_toggled" ID="SvnNewProjectOptionsDialog.on_layoutCheckBox_toggled"></a> @@ -132,9 +138,9 @@ </p> <dl> -<dt><i>checked</i></dt> +<dt><i>checked</i> (bool)</dt> <dd> -flag indicating the state of the checkbox (boolean) +flag indicating the state of the checkbox </dd> </dl> <a NAME="SvnNewProjectOptionsDialog.on_protocolCombo_activated" ID="SvnNewProjectOptionsDialog.on_protocolCombo_activated"></a> @@ -160,9 +166,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -name of the project directory (string) +name of the project directory </dd> </dl> <a NAME="SvnNewProjectOptionsDialog.on_vcsUrlPicker_pickerButtonClicked" ID="SvnNewProjectOptionsDialog.on_vcsUrlPicker_pickerButtonClicked"></a> @@ -181,9 +187,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -current text of the line edit (string) +current text of the line edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnOptionsDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnOptionsDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -92,17 +92,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the version control object </dd> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnOptionsDialog.getData" ID="SvnOptionsDialog.getData"></a> @@ -118,6 +118,12 @@ a dictionary containing the data entered </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="SvnOptionsDialog.on_protocolCombo_activated" ID="SvnOptionsDialog.on_protocolCombo_activated"></a> <h4>SvnOptionsDialog.on_protocolCombo_activated</h4> <b>on_protocolCombo_activated</b>(<i>index</i>) @@ -148,9 +154,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -current text of the line edit (string) +current text of the line edit </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnPropListDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnPropListDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -120,13 +120,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnPropListDialog.__finish" ID="SvnPropListDialog.__finish"></a> @@ -146,17 +146,17 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -file/directory name the property applies to (string) +file/directory name the property applies to </dd> -<dt><i>propName</i></dt> +<dt><i>propName</i> (str)</dt> <dd> -name of the property (string) +name of the property </dd> -<dt><i>propValue</i></dt> +<dt><i>propValue</i> (str)</dt> <dd> -value of the property (string) +value of the property </dd> </dl> <a NAME="SvnPropListDialog.__procFinished" ID="SvnPropListDialog.__procFinished"></a> @@ -168,13 +168,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="SvnPropListDialog.__readStderr" ID="SvnPropListDialog.__readStderr"></a> @@ -222,9 +222,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="SvnPropListDialog.on_buttonBox_clicked" ID="SvnPropListDialog.on_buttonBox_clicked"></a> @@ -236,9 +236,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnPropListDialog.on_refreshButton_clicked" ID="SvnPropListDialog.on_refreshButton_clicked"></a> @@ -257,11 +257,11 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str or list of str)</dt> <dd> -filename(s) (string or list of string) +filename(s) </dd> -<dt><i>recursive</i></dt> +<dt><i>recursive</i> (bool)</dt> <dd> flag indicating a recursive list is requested </dd>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnPropSetDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnPropSetDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,9 +78,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnPropSetDialog.getData" ID="SvnPropSetDialog.getData"></a> @@ -93,9 +93,14 @@ <dl> <dt>Return:</dt> <dd> -tuple of three values giving the property name, a flag - indicating a file was selected and the text of the property - or the selected filename. (string, boolean, string) +tuple containing the property name, a flag indicating a file was + selected and the text of the property or the selected filename +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool, str) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnRelocateDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnRelocateDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,13 +78,13 @@ </p> <dl> -<dt><i>currUrl</i></dt> +<dt><i>currUrl</i> (str)</dt> <dd> -current repository URL (string) +current repository URL </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnRelocateDialog.getData" ID="SvnRelocateDialog.getData"></a> @@ -97,8 +97,14 @@ <dl> <dt>Return:</dt> <dd> -the new repository URL (string) and an indication, if - the relocate is inside the repository (boolean) +the new repository URL and an indication, if the relocate is inside + the repository +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -162,17 +162,17 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>mode</i></dt> +<dt><i>mode</i> (str)</dt> <dd> -mode of the dialog (string, "browse" or "select") +mode of the dialog ("browse" or "select") </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnRepoBrowserDialog.__finish" ID="SvnRepoBrowserDialog.__finish"></a> @@ -192,39 +192,45 @@ </p> <dl> -<dt><i>repopath</i></dt> +<dt><i>repopath</i> (str)</dt> <dd> -path of the item (string) +path of the item </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision info (string) +revision info </dd> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author info (string) +author info </dd> -<dt><i>size</i></dt> +<dt><i>size</i> (str)</dt> <dd> -size info (string) +size info </dd> -<dt><i>date</i></dt> +<dt><i>date</i> (str)</dt> <dd> -date info (string) +date info </dd> -<dt><i>nodekind</i></dt> +<dt><i>nodekind</i> (str)</dt> <dd> -node kind info (string, "dir" or "file") +node kind info ("dir" or "file") </dd> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -url of the entry (string) +url of the entry </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the generated item (QTreeWidgetItem) +reference to the generated item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem </dd> </dl> <a NAME="SvnRepoBrowserDialog.__listRepo" ID="SvnRepoBrowserDialog.__listRepo"></a> @@ -236,14 +242,13 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -the repository URL to browse (string) +the repository URL to browse </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt> <dd> reference to the item, the data should be appended to - (QTreeWidget or QTreeWidgetItem) </dd> </dl> <a NAME="SvnRepoBrowserDialog.__normalizeUrl" ID="SvnRepoBrowserDialog.__normalizeUrl"></a> @@ -255,15 +260,21 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -the url to normalize (string) +the url to normalize </dd> </dl> <dl> <dt>Return:</dt> <dd> -normalized URL (string) +normalized URL +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnRepoBrowserDialog.__procFinished" ID="SvnRepoBrowserDialog.__procFinished"></a> @@ -275,13 +286,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="SvnRepoBrowserDialog.__readStderr" ID="SvnRepoBrowserDialog.__readStderr"></a> @@ -315,15 +326,21 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -the repository URL to browser (string) +the repository URL to browser </dd> </dl> <dl> <dt>Return:</dt> <dd> -repository root (string) +repository root +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnRepoBrowserDialog.__resizeColumns" ID="SvnRepoBrowserDialog.__resizeColumns"></a> @@ -356,9 +373,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="SvnRepoBrowserDialog.getSelectedUrl" ID="SvnRepoBrowserDialog.getSelectedUrl"></a> @@ -371,7 +388,13 @@ <dl> <dt>Return:</dt> <dd> -the selected repository URL (string) +the selected repository URL +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="SvnRepoBrowserDialog.keyPressEvent" ID="SvnRepoBrowserDialog.keyPressEvent"></a> @@ -383,9 +406,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="SvnRepoBrowserDialog.on_input_returnPressed" ID="SvnRepoBrowserDialog.on_input_returnPressed"></a> @@ -404,9 +427,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="SvnRepoBrowserDialog.on_repoTree_itemCollapsed" ID="SvnRepoBrowserDialog.on_repoTree_itemCollapsed"></a> @@ -418,9 +441,9 @@ </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QTreeWidgetItem)</dt> <dd> -reference to the item to be collapsed (QTreeWidgetItem) +reference to the item to be collapsed </dd> </dl> <a NAME="SvnRepoBrowserDialog.on_repoTree_itemExpanded" ID="SvnRepoBrowserDialog.on_repoTree_itemExpanded"></a> @@ -432,9 +455,9 @@ </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QTreeWidgetItem)</dt> <dd> -reference to the item to be expanded (QTreeWidgetItem) +reference to the item to be expanded </dd> </dl> <a NAME="SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged" ID="SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged"></a> @@ -474,9 +497,9 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -the repository URL to browser (string) +the repository URL to browser </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnRevisionSelectionDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnRevisionSelectionDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -83,9 +83,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of the dialog (QWidget) +parent widget of the dialog </dd> </dl> <a NAME="SvnRevisionSelectionDialog.__getRevision" ID="SvnRevisionSelectionDialog.__getRevision"></a> @@ -97,7 +97,7 @@ </p> <dl> -<dt><i>no</i></dt> +<dt><i>no</i> (int)</dt> <dd> revision number to generate (1 or 2) </dd> @@ -105,7 +105,13 @@ <dl> <dt>Return:</dt> <dd> -revision (integer or string) +revision +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int or str </dd> </dl> <a NAME="SvnRevisionSelectionDialog.getRevisions" ID="SvnRevisionSelectionDialog.getRevisions"></a> @@ -118,7 +124,13 @@ <dl> <dt>Return:</dt> <dd> -list two integers or strings +list containing two revisions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of [int or str, int or str] </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -150,7 +150,7 @@ </tr> <tr> <td><a href="#SvnStatusDialog.__removeFromChangelist">__removeFromChangelist</a></td> -<td>Private slot to remove entries from their changelists.</td> +<td>Private slot to remove entries from their change lists.</td> </tr> <tr> <td><a href="#SvnStatusDialog.__resizeColumns">__resizeColumns</a></td> @@ -276,13 +276,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnStatusDialog.__add" ID="SvnStatusDialog.__add"></a> @@ -329,9 +329,9 @@ </p> <dl> -<dt><i>selected</i></dt> +<dt><i>selected</i> (bool)</dt> <dd> -commit selection state to be set (boolean) +commit selection state to be set </dd> </dl> <a NAME="SvnStatusDialog.__commitSelectAll" ID="SvnStatusDialog.__commitSelectAll"></a> @@ -372,49 +372,49 @@ </p> <dl> -<dt><i>status</i></dt> +<dt><i>status</i> (str)</dt> <dd> -status indicator (string) +status indicator </dd> -<dt><i>propStatus</i></dt> +<dt><i>propStatus</i> (str)</dt> <dd> -property status indicator (string) +property status indicator </dd> -<dt><i>locked</i></dt> +<dt><i>locked</i> (str)</dt> <dd> -locked indicator (string) +locked indicator </dd> -<dt><i>history</i></dt> +<dt><i>history</i> (str)</dt> <dd> -history indicator (string) +history indicator </dd> -<dt><i>switched</i></dt> +<dt><i>switched</i> (str)</dt> <dd> -switched indicator (string) +switched indicator </dd> -<dt><i>lockinfo</i></dt> +<dt><i>lockinfo</i> (str)</dt> <dd> -lock indicator (string) +lock indicator </dd> -<dt><i>uptodate</i></dt> +<dt><i>uptodate</i> (str)</dt> <dd> -up to date indicator (string) +up to date indicator </dd> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision string (string) +revision string </dd> -<dt><i>change</i></dt> +<dt><i>change</i> (str)</dt> <dd> -revision of last change (string) +revision of last change </dd> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author of the last change (string) +author of the last change </dd> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -path of the file or directory (string) +path of the file or directory </dd> </dl> <a NAME="SvnStatusDialog.__getChangelistItems" ID="SvnStatusDialog.__getChangelistItems"></a> @@ -431,6 +431,12 @@ list of all items belonging to a changelist </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getCommitableItems" ID="SvnStatusDialog.__getCommitableItems"></a> <h4>SvnStatusDialog.__getCommitableItems</h4> <b>__getCommitableItems</b>(<i></i>) @@ -444,6 +450,12 @@ list of all items, the user has checked </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getLockActionItems" ID="SvnStatusDialog.__getLockActionItems"></a> <h4>SvnStatusDialog.__getLockActionItems</h4> <b>__getLockActionItems</b>(<i>indicators</i>) @@ -453,9 +465,9 @@ </p> <dl> -<dt><i>indicators</i></dt> +<dt><i>indicators</i> (list of str)</dt> <dd> -list of indicators to check against (list of strings) +list of indicators to check against </dd> </dl> <dl> @@ -464,6 +476,12 @@ list of all items with a locked status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getMissingItems" ID="SvnStatusDialog.__getMissingItems"></a> <h4>SvnStatusDialog.__getMissingItems</h4> <b>__getMissingItems</b>(<i></i>) @@ -477,6 +495,12 @@ list of all items with a missing status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getModifiedItems" ID="SvnStatusDialog.__getModifiedItems"></a> <h4>SvnStatusDialog.__getModifiedItems</h4> <b>__getModifiedItems</b>(<i></i>) @@ -490,6 +514,12 @@ list of all items with a modified status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getNonChangelistItems" ID="SvnStatusDialog.__getNonChangelistItems"></a> <h4>SvnStatusDialog.__getNonChangelistItems</h4> <b>__getNonChangelistItems</b>(<i></i>) @@ -504,6 +534,12 @@ list of all items not belonging to a changelist </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__getUnversionedItems" ID="SvnStatusDialog.__getUnversionedItems"></a> <h4>SvnStatusDialog.__getUnversionedItems</h4> <b>__getUnversionedItems</b>(<i></i>) @@ -518,6 +554,12 @@ list of all items with an unversioned status </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of QTreeWidgetItem +</dd> +</dl> <a NAME="SvnStatusDialog.__lock" ID="SvnStatusDialog.__lock"></a> <h4>SvnStatusDialog.__lock</h4> <b>__lock</b>(<i></i>) @@ -534,13 +576,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="SvnStatusDialog.__readStderr" ID="SvnStatusDialog.__readStderr"></a> @@ -570,7 +612,7 @@ <b>__removeFromChangelist</b>(<i></i>) <p> - Private slot to remove entries from their changelists. + Private slot to remove entries from their change lists. </p> <a NAME="SvnStatusDialog.__resizeColumns" ID="SvnStatusDialog.__resizeColumns"></a> <h4>SvnStatusDialog.__resizeColumns</h4> @@ -616,9 +658,9 @@ </p> <dl> -<dt><i>coord</i></dt> +<dt><i>coord</i> (QPoint)</dt> <dd> -the position of the mouse pointer (QPoint) +the position of the mouse pointer </dd> </dl> <a NAME="SvnStatusDialog.__stealLock" ID="SvnStatusDialog.__stealLock"></a> @@ -658,9 +700,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="SvnStatusDialog.keyPressEvent" ID="SvnStatusDialog.keyPressEvent"></a> @@ -672,9 +714,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="SvnStatusDialog.on_addButton_clicked" ID="SvnStatusDialog.on_addButton_clicked"></a> @@ -693,9 +735,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnStatusDialog.on_commitButton_clicked" ID="SvnStatusDialog.on_commitButton_clicked"></a> @@ -728,9 +770,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="SvnStatusDialog.on_refreshButton_clicked" ID="SvnStatusDialog.on_refreshButton_clicked"></a> @@ -791,13 +833,13 @@ </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QTreeWidgetItem)</dt> <dd> -reference to the changed item (QTreeWidgetItem) +reference to the changed item </dd> -<dt><i>column</i></dt> +<dt><i>column</i> (int)</dt> <dd> -index of column that changed (integer) +index of column that changed </dd> </dl> <a NAME="SvnStatusDialog.on_statusList_itemSelectionChanged" ID="SvnStatusDialog.on_statusList_itemSelectionChanged"></a> @@ -816,10 +858,9 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str or list of str)</dt> <dd> filename(s)/directoryname(s) to show the status of - (string or list of strings) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnStatusMonitorThread.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnStatusMonitorThread.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,21 +78,21 @@ </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 (Project) +reference to the project object </dd> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the version control object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QObject)</dt> <dd> -reference to the parent object (QObject) +reference to the parent object </dd> </dl> <a NAME="SvnStatusMonitorThread._performMonitor" ID="SvnStatusMonitorThread._performMonitor"></a> @@ -122,8 +122,14 @@ <dl> <dt>Return:</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> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnSwitchDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnSwitchDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -78,22 +78,21 @@ </p> <dl> -<dt><i>taglist</i></dt> +<dt><i>taglist</i> (list of str)</dt> <dd> -list of previously entered tags (list of strings) +list of previously entered tags </dd> -<dt><i>reposURL</i></dt> +<dt><i>reposURL</i> (str)</dt> <dd> -repository path (string) or None +repository path or None </dd> -<dt><i>standardLayout</i></dt> +<dt><i>standardLayout</i> (bool)</dt> <dd> -flag indicating the layout of the - repository (boolean) +flag indicating the layout of the repository </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnSwitchDialog.getParameters" ID="SvnSwitchDialog.getParameters"></a> @@ -106,7 +105,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of string and int (tag, tag type) +tuple containing the tag and tag type) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, int) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnTagBranchListDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnTagBranchListDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -130,13 +130,13 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnTagBranchListDialog.__finish" ID="SvnTagBranchListDialog.__finish"></a> @@ -156,21 +156,21 @@ </p> <dl> -<dt><i>revision</i></dt> +<dt><i>revision</i> (str)</dt> <dd> -revision string (string) +revision string </dd> -<dt><i>author</i></dt> +<dt><i>author</i> (str)</dt> <dd> -author of the tag (string) +author of the tag </dd> -<dt><i>date</i></dt> +<dt><i>date</i> (str)</dt> <dd> -date of the tag (string) +date of the tag </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name (path) of the tag (string) +name (path) of the tag </dd> </dl> <a NAME="SvnTagBranchListDialog.__procFinished" ID="SvnTagBranchListDialog.__procFinished"></a> @@ -182,13 +182,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="SvnTagBranchListDialog.__readStderr" ID="SvnTagBranchListDialog.__readStderr"></a> @@ -236,9 +236,9 @@ </p> <dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <a NAME="SvnTagBranchListDialog.keyPressEvent" ID="SvnTagBranchListDialog.keyPressEvent"></a> @@ -250,9 +250,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="SvnTagBranchListDialog.on_buttonBox_clicked" ID="SvnTagBranchListDialog.on_buttonBox_clicked"></a> @@ -264,9 +264,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="SvnTagBranchListDialog.on_input_returnPressed" ID="SvnTagBranchListDialog.on_input_returnPressed"></a> @@ -285,9 +285,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="SvnTagBranchListDialog.on_sendButton_clicked" ID="SvnTagBranchListDialog.on_sendButton_clicked"></a> @@ -306,23 +306,22 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -name of directory to be listed (string) +name of directory to be listed </dd> -<dt><i>tags</i></dt> +<dt><i>tags</i> (bool)</dt> <dd> flag indicating a list of tags is requested (False = branches, True = tags) </dd> -<dt><i>tagsList</i></dt> +<dt><i>tagsList</i> (list of str)</dt> <dd> reference to string list receiving the tags - (list of strings) </dd> -<dt><i>allTagsList</i></dt> +<dt><i>allTagsList</i> (list of str)</dt> <dd> -reference to string list all tags (list of strings) +reference to string list all tags </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnTagDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnTagDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -82,22 +82,22 @@ </p> <dl> -<dt><i>taglist</i></dt> +<dt><i>taglist</i> (list of str)</dt> <dd> -list of previously entered tags (list of strings) +list of previously entered tags </dd> -<dt><i>reposURL</i></dt> +<dt><i>reposURL</i> (str)</dt> <dd> -repository path (string) or None +repository path or None </dd> -<dt><i>standardLayout</i></dt> +<dt><i>standardLayout</i> (bool)</dt> <dd> flag indicating the layout of the - repository (boolean) + repository </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="SvnTagDialog.getParameters" ID="SvnTagDialog.getParameters"></a> @@ -110,7 +110,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of string and int (tag, tag operation) +tuple containing the tag and tag operation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, int) </dd> </dl> <a NAME="SvnTagDialog.on_tagCombo_editTextChanged" ID="SvnTagDialog.on_tagCombo_editTextChanged"></a> @@ -122,9 +128,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text of the tag combobox (string) +text of the tag combobox </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnUrlSelectionDialog.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnUrlSelectionDialog.html Sat Dec 23 15:40:23 2023 +0100 @@ -90,25 +90,25 @@ </p> <dl> -<dt><i>vcs</i></dt> +<dt><i>vcs</i> (Subversion)</dt> <dd> reference to the vcs object </dd> -<dt><i>tagsList</i></dt> +<dt><i>tagsList</i> (list of str)</dt> <dd> -list of tags (list of strings) +list of tags </dd> -<dt><i>branchesList</i></dt> +<dt><i>branchesList</i> (list of str)</dt> <dd> -list of branches (list of strings) +list of branches </dd> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -pathname to determine the repository URL from (string) +pathname to determine the repository URL from </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of the dialog (QWidget) +parent widget of the dialog </dd> </dl> <a NAME="SvnUrlSelectionDialog.__changeLabelCombo" ID="SvnUrlSelectionDialog.__changeLabelCombo"></a> @@ -121,13 +121,13 @@ </p> <dl> -<dt><i>labelCombo</i></dt> +<dt><i>labelCombo</i> (QComboBox)</dt> <dd> -reference to the labelCombo object (QComboBox) +reference to the labelCombo object </dd> -<dt><i>type_</i></dt> +<dt><i>type_</i> (str)</dt> <dd> -type string (string) +type string </dd> </dl> <a NAME="SvnUrlSelectionDialog.getURLs" ID="SvnUrlSelectionDialog.getURLs"></a> @@ -140,8 +140,14 @@ <dl> <dt>Return:</dt> <dd> -tuple of list of two URL strings (list of strings) and - a flag indicating a diff summary (boolean) +tuple containing a list of two URL strings and a flag indicating + a diff summary +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, bool) </dd> </dl> <a NAME="SvnUrlSelectionDialog.on_typeCombo1_currentIndexChanged" ID="SvnUrlSelectionDialog.on_typeCombo1_currentIndexChanged"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnUtilities.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnUtilities.html Sat Dec 23 15:40:23 2023 +0100 @@ -74,7 +74,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the config file (string) +filename of the config file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -90,7 +96,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the servers file (string) +filename of the servers file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html Sat Dec 23 15:40:23 2023 +0100 @@ -350,17 +350,17 @@ </p> <dl> -<dt><i>plugin</i></dt> +<dt><i>plugin</i> (VcsSubversionPlugin)</dt> <dd> reference to the plugin object </dd> -<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="Subversion.__svnGetFileForRevision" ID="Subversion.__svnGetFileForRevision"></a> @@ -373,19 +373,25 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file name to get from the repository (string) +file name to get from the repository </dd> -<dt><i>rev</i></dt> +<dt><i>rev</i> (int or str)</dt> <dd> -revision to retrieve (integer or string) +revision to retrieve </dd> </dl> <dl> <dt>Return:</dt> <dd> -contents of the file (string) and an error message (string) +contents of the file (string) and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a> @@ -397,15 +403,21 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -unformatted url string (string) +unformatted url string </dd> </dl> <dl> <dt>Return:</dt> <dd> -properly formated url for subversion (string) +properly formated url for subversion +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Subversion.__vcsAllRegisteredStates_wc" ID="Subversion.__vcsAllRegisteredStates_wc"></a> @@ -427,17 +439,17 @@ </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> -<dt><i>shortcut</i></dt> +<dt><i>shortcut</i> (bool)</dt> <dd> -flag indicating a shortcut should be taken (boolean) +flag indicating a shortcut should be taken </dd> </dl> <dl> @@ -447,6 +459,12 @@ canBeCommited and canBeAdded or None in order to signal an error </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="Subversion.__vcsAllRegisteredStates_wcng" ID="Subversion.__vcsAllRegisteredStates_wcng"></a> <h4>Subversion.__vcsAllRegisteredStates_wcng</h4> <b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname</i>) @@ -466,13 +484,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> @@ -482,6 +500,12 @@ canBeCommited and canBeAdded or None in order to signal an error </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a> <h4>Subversion.__vcsCommit_Step2</h4> <b>__vcsCommit_Step2</b>(<i></i>) @@ -502,15 +526,21 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -filename to check (string) +filename to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -a combination of canBeCommited and canBeAdded +registered state (one of canBeCommited and canBeAdded) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Subversion.__vcsRegisteredState_wcng" ID="Subversion.__vcsRegisteredState_wcng"></a> @@ -526,15 +556,21 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -filename to check (string) +filename to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -a combination of canBeCommited and canBeAdded +registered state (one of canBeCommited and canBeAdded) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Subversion._createStatusMonitorThread" ID="Subversion._createStatusMonitorThread"></a> @@ -547,12 +583,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> @@ -560,7 +595,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> +SvnStatusMonitorThread </dd> </dl> <a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a> @@ -580,7 +621,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the plugin object (VcsSubversionPlugin) +reference to the plugin object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +VcsSubversionPlugin </dd> </dl> <a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a> @@ -595,10 +642,9 @@ </p> <dl> -<dt><i>names</i></dt> +<dt><i>names</i> (str or list of str)</dt> <dd> name or list of names of file or directory to add - (string) </dd> </dl> <a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a> @@ -610,9 +656,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file name to show the blame for (string) +file name to show the blame for </dd> </dl> <a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a> @@ -624,11 +670,11 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name to be copied (string) +file/directory name to be copied </dd> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> @@ -636,7 +682,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> <a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a> @@ -648,11 +700,11 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name (string or list of strings) +file/directory name </dd> -<dt><i>recursive</i></dt> +<dt><i>recursive</i> (bool)</dt> <dd> flag indicating a recursive list is requested </dd> @@ -676,9 +728,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> <a NAME="Subversion.svnGetChangelists" ID="Subversion.svnGetChangelists"></a> @@ -691,7 +743,13 @@ <dl> <dt>Return:</dt> <dd> -list of defined change list names (list of strings) +list of defined change list names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a> @@ -704,9 +762,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -local path to get the svn repository path for (string) +local path to get the svn repository path for </dd> </dl> <dl> @@ -715,6 +773,12 @@ string with the repository path URL </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a> <h4>Subversion.svnListProps</h4> <b>svnListProps</b>(<i>name, recursive=False</i>) @@ -724,11 +788,11 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name (string or list of strings) +file/directory name </dd> -<dt><i>recursive</i></dt> +<dt><i>recursive</i> (bool)</dt> <dd> flag indicating a recursive list is requested </dd> @@ -742,14 +806,14 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -directory name of the project (string) +directory name of the project </dd> -<dt><i>tags</i></dt> +<dt><i>tags</i> (bool)</dt> <dd> flag indicating listing of branches or tags - (False = branches, True = tags) + (False = branches, True = tags) </dd> </dl> <a NAME="Subversion.svnLock" ID="Subversion.svnLock"></a> @@ -761,19 +825,17 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be locked (string or list of - strings) +file/directory name to be locked </dd> -<dt><i>stealIt</i></dt> +<dt><i>stealIt</i> (bool)</dt> <dd> -flag indicating a forced operation (boolean) +flag indicating a forced operation </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent object of the subversion dialog - (QWidget) </dd> </dl> <a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a> @@ -785,15 +847,21 @@ </p> <dl> -<dt><i>url</i></dt> +<dt><i>url</i> (str)</dt> <dd> -url string (string) +url string </dd> </dl> <dl> <dt>Return:</dt> <dd> -properly normalized url for subversion (string) +properly normalized url for subversion +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a> @@ -805,9 +873,9 @@ </p> <dl> -<dt><i>projectPath</i></dt> +<dt><i>projectPath</i> (str)</dt> <dd> -path name of the project (string) +path name of the project </dd> </dl> <a NAME="Subversion.svnRemoveFromChangelist" ID="Subversion.svnRemoveFromChangelist"></a> @@ -822,10 +890,9 @@ </p> <dl> -<dt><i>names</i></dt> +<dt><i>names</i> (str or list of str)</dt> <dd> name or list of names of file or directory to remove - (string) </dd> </dl> <a NAME="Subversion.svnRepoBrowser" ID="Subversion.svnRepoBrowser"></a> @@ -837,9 +904,9 @@ </p> <dl> -<dt><i>projectPath</i></dt> +<dt><i>projectPath</i> (str)</dt> <dd> -path name of the project (string) +path name of the project </dd> </dl> <a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a> @@ -851,11 +918,11 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name (string or list of strings) +file/directory name </dd> -<dt><i>recursive</i></dt> +<dt><i>recursive</i> (bool)</dt> <dd> flag indicating a recursive list is requested </dd> @@ -869,9 +936,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -directory name to show change lists for (string) +directory name to show change lists for </dd> </dl> <a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a> @@ -883,19 +950,17 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be unlocked (string or list of - strings) +file/directory name to be unlocked </dd> -<dt><i>breakIt</i></dt> +<dt><i>breakIt</i> (bool)</dt> <dd> -flag indicating a forced operation (boolean) +flag indicating a forced operation </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent object of the subversion dialog - (QWidget) </dd> </dl> <a NAME="Subversion.svnUpgrade" ID="Subversion.svnUpgrade"></a> @@ -907,9 +972,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -directory name to show change lists for (string) +directory name to show change lists for </dd> </dl> <a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a> @@ -931,9 +996,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> <a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a> @@ -946,15 +1011,15 @@ </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 </dd> @@ -969,13 +1034,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> <a NAME="Subversion.vcsAddCommitMessage" ID="Subversion.vcsAddCommitMessage"></a> @@ -1002,10 +1067,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str or list of str)</dt> <dd> -root directory of the tree to be added (string or list of - strings)) +root directory of the tree to be added </dd> </dl> <a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a> @@ -1023,17 +1087,17 @@ </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> -<dt><i>shortcut</i></dt> +<dt><i>shortcut</i> (bool)</dt> <dd> -flag indicating a shortcut should be taken (boolean) +flag indicating a shortcut should be taken </dd> </dl> <dl> @@ -1043,6 +1107,12 @@ canBeCommited and canBeAdded or None in order to signal an error </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a> <h4>Subversion.vcsCheckout</h4> <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) @@ -1053,15 +1123,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> @@ -1069,7 +1139,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> <a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a> @@ -1081,9 +1157,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> <a NAME="Subversion.vcsClearCommitMessages" ID="Subversion.vcsClearCommitMessages"></a> @@ -1102,9 +1178,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> <a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a> @@ -1117,16 +1193,15 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be committed (string or list of - strings) +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 </dd> @@ -1189,9 +1264,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> <a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a> @@ -1205,7 +1280,12 @@ <dt>Return:</dt> <dd> flag indicating the existance (boolean) and an error message - (string) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a> @@ -1218,19 +1298,25 @@ </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> </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> <a NAME="Subversion.vcsForget" ID="Subversion.vcsForget"></a> @@ -1261,15 +1347,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) @@ -1281,6 +1367,12 @@ the project browser helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +SvnProjectBrowserHelper +</dd> +</dl> <a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a> <h4>Subversion.vcsGetProjectHelper</h4> <b>vcsGetProjectHelper</b>(<i>project</i>) @@ -1290,7 +1382,7 @@ </p> <dl> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> reference to the project object </dd> @@ -1301,6 +1393,12 @@ the project helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +SvnProjectHelper +</dd> +</dl> <a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a> <h4>Subversion.vcsImport</h4> <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>) @@ -1317,7 +1415,7 @@ </dd> <dt><i>projectDir</i> (str)</dt> <dd> -project directory (string) +project directory </dd> <dt><i>noDialog</i> (bool)</dt> <dd> @@ -1355,19 +1453,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> -always TRUE +always True +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a> @@ -1382,9 +1486,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="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a> @@ -1397,13 +1501,13 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name to show the log of (string) +file/directory name to show the log of </dd> -<dt><i>isFile</i></dt> +<dt><i>isFile</i> (bool)</dt> <dd> -flag indicating log for a file is to be shown (boolean) +flag indicating log for a file is to be shown </dd> </dl> <a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a> @@ -1415,9 +1519,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> <a NAME="Subversion.vcsMove" ID="Subversion.vcsMove"></a> @@ -1429,19 +1533,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> @@ -1449,7 +1553,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> <a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a> @@ -1462,7 +1572,13 @@ <dl> <dt>Return:</dt> <dd> -always 'Subversion' (string) +always 'Subversion' +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a> @@ -1475,16 +1591,21 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <dl> <dt>Return:</dt> <dd> reference to the instantiated options dialog - (SvnNewProjectOptionsDialog) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +SvnNewProjectOptionsDialog </dd> </dl> <a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a> @@ -1496,28 +1617,33 @@ </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> <dt>Return:</dt> <dd> -reference to the instantiated options dialog (SvnOptionsDialog) +reference to the instantiated options dialog +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +SvnOptionsDialog </dd> </dl> <a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a> @@ -1529,15 +1655,21 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -filename to check (string) +filename to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -a combination of canBeCommited and canBeAdded +registered state (one of canBeCommited and canBeAdded) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a> @@ -1553,17 +1685,15 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be removed (string or list of - strings)) +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) - (not needed) +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> @@ -1571,7 +1701,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> <a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a> @@ -1583,15 +1719,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> <a NAME="Subversion.vcsResolved" ID="Subversion.vcsResolved"></a> @@ -1603,9 +1745,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file/directory name to be resolved (string) +file/directory name to be resolved </dd> </dl> <a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a> @@ -1645,17 +1787,17 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -file name to be diffed (string) +file name to be diffed </dd> -<dt><i>extended</i></dt> +<dt><i>extended</i> (bool)</dt> <dd> -flag indicating the extended variant (boolean) +flag indicating the extended variant </dd> -<dt><i>revisions</i></dt> +<dt><i>revisions</i> (tuple of (str, str))</dt> <dd> -tuple of two revisions (tuple of strings) +tuple of two revisions </dd> </dl> <dl> @@ -1682,10 +1824,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> file/directory name(s) to show the status of - (string or list of strings) </dd> </dl> <a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a> @@ -1697,15 +1838,21 @@ </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 added or changed files (boolean) +flag indicating added or changed files +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a> @@ -1718,9 +1865,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> <a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a> @@ -1733,21 +1880,25 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str or list of str)</dt> <dd> -file/directory name to be updated (string or list of - strings) +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) +flag indicating, that the update contained an add or delete +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.VCS.ProjectBrowserHelper.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.VCS.ProjectBrowserHelper.html Sat Dec 23 15:40:23 2023 +0100 @@ -319,7 +319,7 @@ <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i> (list of BrowserItem)</dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -350,7 +350,7 @@ <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i> (list of BrowserItem)</dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -381,7 +381,7 @@ <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i> (list of BrowserItem)</dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status @@ -413,7 +413,7 @@ <dd> reference to the menu to be shown </dd> -<dt><i>standardItems</i> (list of BrowserItem)</dt> +<dt><i>standardItems</i> (list of QAction)</dt> <dd> array of standard items that need activation/deactivation depending on the overall VCS status
--- a/src/eric7/Documentation/Source/eric7.VCS.VersionControl.html Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.VCS.VersionControl.html Sat Dec 23 15:40:23 2023 +0100 @@ -1670,8 +1670,7 @@ <dl> <dt>Return:</dt> <dd> -a combination of canBeCommited and canBeAdded or - 0 in order to signal an error +registered state (one of canBeCommited and canBeAdded) </dd> </dl> <dl>
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitApplyBundleDataDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitApplyBundleDataDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,9 +22,11 @@ Constructor @param bundleHeads list of heads contained in a bundle - (list of strings) - @param branches list of available branch names (list of strings) - @param parent reference to the parent widget (QWidget) + @type list of str + @param branches list of available branch names + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -36,7 +38,7 @@ """ Public method to get the entered data. - @return tuple with the bundle head (string) and the local branch - name (string) + @return tuple with the bundle head (string) and the local branch name + @rtype str """ return self.headCombo.currentText(), self.branchCombo.currentText()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitArchiveDataDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitArchiveDataDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -29,10 +29,14 @@ """ Constructor - @param tagsList list of tags (list of strings) - @param branchesList list of branches (list of strings) - @param formatsList list of archive formats (list of strings) - @param parent reference to the parent widget (QWidget) + @param tagsList list of tags + @type list of str + @param branchesList list of branches + @type list of str + @param formatsList list of archive formats + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -70,7 +74,8 @@ """ Private slot to handle changes of the file edit. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__updateOK() @@ -98,7 +103,8 @@ """ Private slot to handle changes of the rev select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -107,7 +113,8 @@ """ Private slot to handle changes of the rev edit. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__updateOK() @@ -116,7 +123,8 @@ """ Private slot to handle changes of the Tag select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -125,7 +133,8 @@ """ Private slot to handle changes of the Tag combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -134,7 +143,8 @@ """ Private slot to handle changes of the Branch select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -143,7 +153,8 @@ """ Private slot to handle changes of the Branch combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -151,8 +162,8 @@ """ Public method to retrieve the entered data. - @return tuple of selected revision (string), archive format (string), - archive file (string) and prefix (string) + @return tuple of selected revision, archive format, archive file and prefix + @rtype tuple of (str, str, str, str) """ if self.revButton.isChecked(): rev = self.revEdit.text()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitBisectLogBrowserDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitBisectLogBrowserDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -41,7 +41,9 @@ Constructor @param vcs reference to the vcs object - @param parent reference to the parent widget (QWidget) + @type Git + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -82,7 +84,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.__process is not None @@ -123,10 +126,14 @@ """ Private method to generate a bisect log tree entry. - @param commitId commit id info (string) - @param operation bisect operation (string) - @param subject subject of the bisect log entry (string) - @return reference to the generated item (QTreeWidgetItem) + @param commitId commit id info + @type str + @param operation bisect operation + @type str + @param subject subject of the bisect log entry + @type str + @return reference to the generated item + @rtype QTreeWidgetItem """ columnLabels = [ commitId, @@ -181,7 +188,8 @@ """ Public slot to start the git bisect log command. - @param projectdir directory name of the project (string) + @param projectdir directory name of the project + @type str """ self.errorGroup.hide() QApplication.processEvents() @@ -204,8 +212,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__processBuffer() self.__finish() @@ -293,7 +303,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out) @@ -303,7 +314,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -331,7 +343,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -370,7 +383,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitBisectStartDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitBisectStartDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,7 +22,8 @@ """ Constructor - @param parent reference to the parent widget (QWidget) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -45,7 +46,8 @@ """ Private slot to handle a change of the bad commit. - @param txt bad commit entered (string) + @param txt bad commit entered + @type str """ self.__updateOK() @@ -53,9 +55,9 @@ """ Public method to get the entered data. - @return tuple containing a bad commit (string), a list of good - commits (list of strings) and a flag indicating to not - checkout the working tree (boolean) + @return tuple containing a bad commit, a list of good commits and + a flag indicating to not checkout the working tree + @rtype tuple of (str, list of str, bool) """ return ( self.badEdit.text().strip(),
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitBlameDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitBlameDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -36,7 +36,9 @@ Constructor @param vcs reference to the vcs object - @param parent reference to the parent widget (QWidget) + @type Git + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -70,7 +72,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.process is not None @@ -162,7 +165,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -174,8 +178,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__finish() @@ -284,7 +290,8 @@ """ Private slot to handle the password checkbox toggled. - @param checked flag indicating the status of the check box (boolean) + @param checked flag indicating the status of the check box + @type bool """ if checked: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -295,7 +302,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitBranchDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitBranchDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -32,11 +32,16 @@ """ Constructor - @param branchlist list of previously entered branches (list of strings) - @param revision revision to set tag for (string) - @param branchName name of the branch (string) - @param branchOp desired branch operation (integer) - @param parent parent widget (QWidget) + @param branchlist list of previously entered branches + @type list of str + @param revision revision to set tag for + @type str + @param branchName name of the branch + @type str + @param branchOp desired branch operation + @type int + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -107,7 +112,8 @@ """ Private slot to handle the selection of creating a tracking branch. - @param checked state of the selection (boolean) + @param checked state of the selection + @type bool """ self.branchCombo.setEditable(not checked) self.branchCombo.clear() @@ -123,7 +129,8 @@ """ Private slot to handle the selection of setting a tracking branch. - @param checked state of the selection (boolean) + @param checked state of the selection + @type bool """ self.__updateOK() @@ -132,7 +139,8 @@ """ Private slot to handle the selection of unsetting a tracking branch. - @param checked state of the selection (boolean) + @param checked state of the selection + @type bool """ self.__updateOK() @@ -141,7 +149,8 @@ """ Private slot to handle a change of the branch. - @param text branch name entered in the combo (string) + @param text branch name entered in the combo + @type str """ self.__updateOK() @@ -150,7 +159,8 @@ """ Private slot to handle a change of the new branch. - @param text new branch name entered (string) + @param text new branch name entered + @type str """ self.__updateOK() @@ -158,9 +168,10 @@ """ Public method to retrieve the branch data. - @return tuple of an int, four strings and a boolean - (branch operation, branch name, revision, new branch name, - remote branch name, enforce operation) + @return tuple containing the branch operation, branch name, revision, + new branch name, remote branch name and a flag indicating to enforce + the operation + @rtype tuple of (int, str, str, str, str, bool) """ branch = self.branchCombo.currentText().replace(" ", "_")
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitBranchPushDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitBranchPushDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,10 +22,14 @@ """ Constructor - @param branches list of branch names (list of string) - @param remotes list of remote names (list of string) - @param delete flag indicating a delete branch action (boolean) - @param parent reference to the parent widget (QWidget) + @param branches list of branch names + @type list of str + @param remotes list of remote names + @type list of str + @param delete flag indicating a delete branch action + @type bool + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -62,7 +66,8 @@ """ Private slot to handle a change of the branch name. - @param txt branch name (string) + @param txt branch name + @type str """ self.__okButton.setEnabled(bool(txt)) @@ -71,7 +76,8 @@ Public method to get the selected data. @return tuple of selected branch name, remote name and a flag - indicating all branches (tuple of two strings and a boolean) + indicating all branches + @rtype tuple of (str, str, bool) """ return ( self.branchComboBox.currentText(),
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitBundleDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitBundleDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,9 +22,12 @@ """ Constructor - @param tagsList list of tags (list of strings) - @param branchesList list of branches (list of strings) - @param parent parent widget (QWidget) + @param tagsList list of tags + @type list of str + @param branchesList list of branches + @type list of str + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -53,7 +56,8 @@ """ Private slot to handle changes of the revisions select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -62,7 +66,8 @@ """ Private slot to handle changes of the Tag select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -71,7 +76,8 @@ """ Private slot to handle changes of the Branch select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -80,7 +86,8 @@ """ Private slot to handle changes of the Revisions edit. - @param txt text of the line edit (string) + @param txt text of the line edit + @type str """ self.__updateOK() @@ -89,7 +96,8 @@ """ Private slot to handle changes of the Tag combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -98,7 +106,8 @@ """ Private slot to handle changes of the Branch combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -106,7 +115,8 @@ """ Public method to retrieve the bundle data. - @return list of revision expressions (list of strings) + @return list of revision expressions + @rtype list of str """ if self.revisionsButton.isChecked(): revs = self.revisionsEdit.text().strip().split()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitCherryPickDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitCherryPickDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,9 +22,10 @@ """ Constructor - @param commits list of commits to show in the commits pane (list of - strings) - @param parent reference to the parent widget (QWidget) + @param commits list of commits to show in the commits pane + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -50,7 +51,8 @@ @return tuple with list of commits, a flag indicating to append cherry-pick info to the commit message, a flag indicating to append a signed-off-by line to the commit message and a flag indicating to - not commit the action (list of strings, boolean, boolean, boolean) + not commit the action + @rtype tuple of (list of str, bool, bool, bool) """ return ( self.commitsEdit.toPlainText().strip().splitlines(),
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitCommandDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitCommandDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -28,9 +28,12 @@ """ Constructor - @param argvList history list of commandline arguments (list of strings) - @param ppath pathname of the project directory (string) - @param parent parent widget of this dialog (QWidget) + @param argvList history list of commandline arguments + @type list of str + @param ppath pathname of the project directory + @type str + @param parent parent widget of this dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -61,7 +64,8 @@ """ Private method used to enable/disable the OK-button. - @param text ignored + @param text text of the combobox + @type str """ self.okButton.setDisabled(self.commandCombo.currentText() == "") @@ -69,6 +73,7 @@ """ Public method to retrieve the data entered into this dialog. - @return commandline parameters (string) + @return commandline parameters + @rtype str """ return self.commandCombo.currentText()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitCommitDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitCommitDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -31,10 +31,15 @@ Constructor @param vcs reference to the vcs object - @param msg initial message (string) - @param amend flag indicating to amend the HEAD commit (boolean) - @param commitAll flag indicating to commit all local changes (boolean) - @param parent parent widget (QWidget) + @type Git + @param msg initial message + @type str + @param amend flag indicating to amend the HEAD commit + @type bool + @param commitAll flag indicating to commit all local changes + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent, Qt.WindowType.Window) self.setupUi(self) @@ -54,7 +59,8 @@ """ Protected method called when the dialog is about to be shown. - @param evt the event (QShowEvent) + @param evt the event + @type QShowEvent """ commitMessages = self.__vcs.vcsCommitMessages() self.recentComboBox.clear() @@ -71,7 +77,8 @@ """ Public method to retrieve the log message. - @return the log message (string) + @return the log message + @rtype str """ msg = self.logEdit.toPlainText() if msg: @@ -83,7 +90,8 @@ """ Public method to retrieve the state of the staged only flag. - @return state of the staged only flag (boolean) + @return state of the staged only flag + @rtype bool """ return self.stagedCheckBox.isChecked() @@ -91,7 +99,8 @@ """ Public method to retrieve the state of the amend flag. - @return state of the amend flag (boolean) + @return state of the amend flag + @rtype bool """ return self.amendCheckBox.isChecked() @@ -99,7 +108,8 @@ """ Public method to retrieve the state of the reset author flag. - @return state of the reset author flag (boolean) + @return state of the reset author flag + @rtype bool """ return self.resetAuthorCheckBox.isChecked() @@ -107,7 +117,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel): self.logEdit.clear()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitCopyDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitCopyDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -30,9 +30,12 @@ """ Constructor - @param source name of the source file/directory (string) - @param parent parent widget (QWidget) - @param move flag indicating a move operation (boolean) + @param source name of the source file/directory + @type str + @param parent parent widget + @type QWidget + @param move flag indicating a move operation + @type bool """ super().__init__(parent) self.setupUi(self) @@ -61,8 +64,8 @@ """ Public method to retrieve the copy data. - @return the target name (string) and a flag indicating - the operation should be enforced (boolean) + @return the target name and a flag indicating the operation should be enforced + @rtype tuple of (str, bool) """ target = self.targetEdit.text() if not os.path.isabs(target): @@ -104,7 +107,8 @@ """ Private slot to handle changes of the target. - @param txt contents of the target edit (string) + @param txt contents of the target edit + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( os.path.isabs(txt) or os.path.dirname(txt) == ""
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitDescribeDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitDescribeDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -35,7 +35,9 @@ Constructor @param vcs reference to the vcs object - @param parent reference to the parent widget (QWidget) + @type Git + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -61,7 +63,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.process is not None @@ -77,8 +80,10 @@ """ Public slot to start the tag/branch list command. - @param path name of directory to be listed (string) - @param commits list of commits to be described (list of string) + @param path name of directory to be listed + @type str + @param commits list of commits to be described + @type list of str """ self.tagList.clear() self.errorGroup.hide() @@ -155,7 +160,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -167,8 +173,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ if self.__tagInfoLines: if self.__commits: @@ -231,7 +239,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -269,7 +278,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -39,9 +39,12 @@ """ Constructor - @param text text to be shown by the label (string) - @param git reference to the Git interface object (Git) - @param parent parent widget (QWidget) + @param text text to be shown by the label + @type str + @param git reference to the Git interface object + @type Git + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -98,7 +101,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -110,8 +114,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.normal = (exitStatus == QProcess.ExitStatus.NormalExit) and (exitCode == 0) if self.normal: @@ -128,12 +134,17 @@ """ Public slot used to start the process. - @param args list of arguments for the process (list of strings) - @param workingDir working directory for the process (string) - @param showArgs flag indicating to show the arguments (boolean) + @param args list of arguments for the process + @type list of str + @param workingDir working directory for the process + @type str + @param showArgs flag indicating to show the arguments + @type bool @param environment dictionary of environment settings to add - or change for the git process (dict of string and string) - @return flag indicating a successful start of the process (boolean) + or change for the git process + @type dict + @return flag indicating a successful start of the process + @rtype bool """ self.errorGroup.hide() self.normal = False @@ -196,7 +207,8 @@ """ Public method to check for a normal process termination. - @return flag indicating normal process termination (boolean) + @return flag indicating normal process termination + @rtype bool """ return self.normal @@ -205,7 +217,8 @@ Public method to check for a normal process termination without error messages. - @return flag indicating normal process termination (boolean) + @return flag indicating normal process termination + @rtype bool """ return self.normal and self.errors.toPlainText() == "" @@ -228,7 +241,8 @@ """ Private slot to show some output. - @param out output to be shown (string) + @param out output to be shown + @type str """ self.resultbox.insertPlainText(out) self.resultbox.ensureCursorVisible() @@ -261,7 +275,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out) @@ -273,7 +288,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -311,7 +327,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False @@ -323,6 +340,7 @@ """ Public method to check, if the last action contained an add or delete. - @return flag indicating the presence of an add or delete (boolean) + @return flag indicating the presence of an add or delete + @rtype bool """ return self.__hasAddOrDelete
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -36,7 +36,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Git + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -94,7 +96,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ self.__diffGenerator.stopProcesses() e.accept() @@ -105,9 +108,10 @@ """ Public slot to start the git diff command. - @param fn filename to be diffed (string) - @param versions list of versions to be diffed (list of up to 2 strings - or None) + @param fn filename to be diffed + @type str + @param versions list of versions to be diffed + @type list of up to 2 str or None @param diffMode indication for the type of diff to be performed ( 'work2repo' compares the working tree with the HEAD commit, 'work2stage' compares the working tree with the staging area, @@ -115,8 +119,11 @@ 'work2stage2repo' compares the working tree with the staging area and the staging area with the HEAD commit, 'stash' shows the diff for a stash) - @param stashName name of the stash to show a diff for (string) - @param refreshable flag indicating a refreshable diff (boolean) + @type str + @param stashName name of the stash to show a diff for + @type str + @param refreshable flag indicating a refreshable diff + @type bool @exception ValueError raised to indicate a bad value for the 'diffMode' parameter. """ @@ -230,7 +237,9 @@ Private method to merge the file separator entries. @param fileSeparators list of file separator entries to be merged + @type list of str @return merged list of file separator entries + @rtype list of str """ separators = {} for oldFile, newFile, pos1, pos2 in sorted(fileSeparators): @@ -247,7 +256,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Save): self.on_saveButton_clicked() @@ -259,7 +269,8 @@ """ Private slot to handle the selection of a file. - @param index activated row (integer) + @param index activated row + @type int """ para1, para2 = self.filesCombo.itemData(index)
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffGenerator.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffGenerator.py Sat Dec 23 15:40:23 2023 +0100 @@ -28,7 +28,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Git + @param parent parent widget + @type QWidget """ super().__init__(parent) @@ -69,9 +71,10 @@ """ Public slot to start the git diff command. - @param fn filename to be diffed (string) - @param versions list of versions to be diffed (list of up to 2 strings - or None) + @param fn filename to be diffed + @type str + @param versions list of versions to be diffed + @type list of up to 2 str or None @param diffMode indication for the type of diff to be performed ( 'work2repo' compares the working tree with the HEAD commit, 'work2stage' compares the working tree with the staging area, @@ -79,8 +82,11 @@ 'work2stage2repo' compares the working tree with the staging area and the staging area with the HEAD commit, 'stash' shows the diff for a stash) - @param stashName name of the stash to show a diff for (string) - @return flag indicating the start status (boolean) + @type str + @param stashName name of the stash to show a diff for + @type str + @return flag indicating the start status + @rtype bool @exception ValueError raised to indicate a bad value for the 'diffMode' parameter. """ @@ -166,8 +172,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ if ( self.__process.state() == QProcess.ProcessState.NotRunning @@ -183,6 +191,7 @@ between stage and repo for 'work2stage2repo' mode (empty otherwise), the list of errors and a list of tuples of filenames and the line into the diff output. + @rtype tuple of (list of str, list of str, list of str, list of (str, int)) """ return (self.__output1, self.__output2, self.__errors, self.__fileSeparators) @@ -190,9 +199,11 @@ """ Private slot to process a line giving the old/new file. - @param line line to be processed (string) + @param line line to be processed + @type str @param isTopDiff flag indicating to show the output in the top - output widget (boolean) + output widget + @type bool """ prefix, filenames = line.split(" a/", 1) oldFile, newFile = filenames.split(" b/", 1) @@ -209,9 +220,11 @@ """ Private method to process one line of output. - @param line output line to process (string) + @param line output line to process + @type str @param isTopDiff flag indicating to show the output in the top - output widget (boolean) + output widget + @type bool """ if line.startswith("diff --git"): self.__processFileLine(line, isTopDiff)
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffHighlighter.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffHighlighter.py Sat Dec 23 15:40:23 2023 +0100 @@ -24,9 +24,11 @@ """ Constructor - @param doc reference to the text document (QTextDocument) + @param doc reference to the text document + @type QTextDocument @param whitespace flag indicating to highlight whitespace - at the end of a line (boolean) + at the end of a line + @type bool """ self.whitespace = whitespace
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffParser.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffParser.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,7 +22,8 @@ """ Constructor - @param diff output of the diff command (list of string) + @param diff output of the diff command + @type list of str """ self.__diff = diff[:] @@ -35,7 +36,8 @@ """ Private method to initialize a hunk data structure. - @return hunk data structure (dictionary) + @return hunk data structure + @rtype dict """ hunk = { "start": -1, @@ -53,8 +55,10 @@ """ Private method to parse the hunk header range part. - @param headerRange hunk header range (string) - @return tuple of hunk start and hunk length (integer, integer) + @param headerRange hunk header range + @type str + @return tuple of hunk start and hunk length + @rtype tuple of (int, int) """ if "," in headerRange: begin, end = headerRange.split(",", 1) @@ -104,9 +108,12 @@ """ Private method to generate a hunk header range. - @param start start line (integer) - @param count line count (integer) - @return hunk header range (string) + @param start start line + @type int + @param count line count + @type int + @return hunk header range + @rtype str """ if count == 1: return "{0}".format(start) @@ -119,12 +126,18 @@ """ Private method to generate a hunk header line. - @param oldStart start line of the old part (integer) - @param oldCount line count of the old part (integer) - @param newStart start line of the new part (integer) - @param newCount line count of the new part (integer) - @param heading hunk heading (string) - @return hunk header (string) + @param oldStart start line of the old part + @type int + @param oldCount line count of the old part + @type int + @param newStart start line of the new part + @type int + @param newCount line count of the new part + @type int + @param heading hunk heading + @type str + @return hunk header + @rtype str """ return "@@ -{0} +{1} @@{2}".format( self.__generateRange(oldStart, oldCount), @@ -136,7 +149,8 @@ """ Public method to get the header length. - @return length of the header (integer) + @return length of the header + @rtype int """ self.__parseDiff() return len(self.__headerLines) @@ -145,8 +159,10 @@ """ Public method to create a hunk based patch. - @param lineIndex line number of the hunk (integer) - @return diff lines of the patch (string) + @param lineIndex line number of the hunk + @type int + @return diff lines of the patch + @rtype str """ self.__parseDiff() @@ -162,10 +178,14 @@ """ Public method to create a selected lines based patch. - @param startIndex start line number (integer) - @param endIndex end line number (integer) - @param reverse flag indicating a reverse patch (boolean) - @return diff lines of the patch (string) + @param startIndex start line number + @type int + @param endIndex end line number + @type int + @param reverse flag indicating a reverse patch + @type bool + @return diff lines of the patch + @rtype str """ self.__parseDiff()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitFetchDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitFetchDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,8 +23,11 @@ Constructor @param vcs reference to the git object - @param repodir directory name of the local repository (string) - @param parent reference to the parent widget (QWidget) + @type Git + @param repodir directory name of the local repository + @type str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -78,7 +81,8 @@ """ Private slot to handle changes of the selected repository. - @param txt current text of the combo box (string) + @param txt current text of the combo box + @type str """ self.remoteEdit.setReadOnly(txt != self.__custom) self.remoteBranchesList.setEnabled(txt != self.__all) @@ -99,7 +103,8 @@ """ Private slot to handle changes of the URL edit. - @param txt current text of the URL edit (string) + @param txt current text of the URL edit + @type str """ self.__updateButtonEnable() @@ -156,8 +161,7 @@ remote branches, local branch, a flag indicating to fetch from all repositories, a flag indicating to remove obsolete tracking references and a flag indicating to fetch tags as well - (string, string, list of strings, string, boolean, boolean, - boolean) + @rtype tuple of (str, str, list of str, str, bool, bool, bool) """ remote = "" url = ""
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitListDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitListDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -21,8 +21,10 @@ """ Constructor - @param selections list of entries to select from (list of string) - @param parent reference to the parent widget (QWidget) + @param selections list of entries to select from + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -33,7 +35,8 @@ """ Public method to return the selected entries. - @return list of selected entries (list of string) + @return list of selected entries + @rtype list of str """ selection = [] for itm in self.selectionList.selectedItems():
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitLogBrowserDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitLogBrowserDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -93,7 +93,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Git + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -404,7 +406,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.__process is not None @@ -512,12 +515,14 @@ """ Private method to generate edge info for the give data. - @param commitId commit id to calculate edge info for (string) - @param parents list of parent commits (list of strings) + @param commitId commit id to calculate edge info for + @type str + @param parents list of parent commits + @type list of str @return tuple containing the column and color index for the given node and a list of tuples indicating the edges between the given node and its parents - (integer, integer, [(integer, integer, integer), ...]) + @rtype tuple of (int, int, [(int, int, int), ...]) """ if commitId not in self.__commitIds: # new head @@ -567,23 +572,29 @@ Private method to generate an icon containing the revision tree for the given data. - @param column column index of the revision (integer) + @param column column index of the revision + @type int @param bottomedges list of edges for the bottom of the node - (list of tuples of three integers) + @type list of [(int, int, int)] @param topedges list of edges for the top of the node - (list of tuples of three integers) - @param dotColor color to be used for the dot (QColor) + @type list of [(int, int, int)] + @param dotColor color to be used for the dot + @type QColor @param currentCommit flag indicating to draw the icon for the - current commit (boolean) - @return icon for the node (QIcon) + current commit + @type bool + @return icon for the node + @rtype QIcon """ def col2x(col, radius): """ Local function to calculate a x-position for a column. - @param col column number (integer) - @param radius radius of the indicator circle (integer) + @param col column number + @type int + @param radius radius of the indicator circle + @type int """ return int(1.2 * radius) * col + radius // 2 + 3 @@ -688,21 +699,35 @@ """ Private method to generate a log tree entry. - @param author author info (string) - @param date date info (string) - @param committer committer info (string) - @param commitDate commit date info (string) - @param subject subject of the log entry (string) - @param message text of the log message (list of strings) - @param commitId commit id info (string) - @param fullCommitId unabbreviated commit id info (string) + @param author author info + @type str + @param date date info + @type str + @param committer committer info + @type str + @param commitDate commit date info + @type str + @param subject subject of the log entry + @type str + @param message text of the log message + @type list of str + @param commitId commit id info + @type str + @param fullCommitId unabbreviated commit id info + @type str @param changedPaths list of dictionary objects containing info about the changed files/directories - @param parents list of parent revisions (list of integers) - @param refnames tags and branches of the commit (string) - @param authorMail author's email address (string) - @param committerMail committer's email address (string) - @return reference to the generated item (QTreeWidgetItem) + @type list of dict + @param parents list of parent revisions + @type list of int + @param refnames tags and branches of the commit + @type str + @param authorMail author's email address + @type str + @param committerMail committer's email address + @type str + @return reference to the generated item + @rtype QTreeWidgetItem """ branches = [] allBranches = [] @@ -787,11 +812,17 @@ @param action indicator for the change action ("A", "C", "D", "M", "R", "T", "U", "X") - @param path path of the file in the repository (string) - @param copyfrom path the file was copied from (string) - @param additions number of added lines (int) - @param deletions number of deleted lines (int) - @return reference to the generated item (QTreeWidgetItem) + @type str + @param path path of the file in the repository + @type str + @param copyfrom path the file was copied from + @type str + @param additions number of added lines + @type int + @param deletions number of deleted lines + @type int + @return reference to the generated item + @rtype QTreeWidgetItem """ if len(action) > 1: # includes confidence level @@ -821,8 +852,10 @@ """ Private method to retrieve log entries from the repository. - @param skip number of log entries to skip (integer) - @param noEntries number of entries to get (0 = default) (int) + @param skip number of log entries to skip + @type int + @param noEntries number of entries to get (0 = default) + @type int """ self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setEnabled(False) self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel).setEnabled(True) @@ -877,10 +910,12 @@ """ Public slot to start the git log command. - @param fn filename to show the log for (string) + @param fn filename to show the log for + @type str @param isFile flag indicating log for a file is to be shown - (boolean) - @param noEntries number of entries to get (0 = default) (int) + @type bool + @param noEntries number of entries to get (0 = default) + @type int """ self.__isFile = isFile @@ -914,8 +949,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__processBuffer() self.__finish() @@ -949,6 +986,7 @@ Private method to process a log entry. @param logEntry dictionary as generated by __processBuffer + @type dict """ self.__generateLogItem( logEntry["author"], @@ -1147,7 +1185,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out) @@ -1161,7 +1200,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -1197,7 +1237,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -1236,7 +1277,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False @@ -1249,7 +1291,8 @@ Private slot to prepare the filed search data. @return tuple of field index, search expression and flag indicating - that the field index is a data role (integer, string, boolean) + that the field index is a data role + @rtype tuple of (int, str, bool) """ indexIsRole = False txt = self.fieldCombo.itemData(self.fieldCombo.currentIndex()) @@ -1593,8 +1636,10 @@ """ Private method to get the commit id for a tag. - @param tag tag name (string) - @return commit id shortened to 10 characters (string) + @param tag tag name + @type str + @return commit id shortened to 10 characters + @rtype str """ args = self.vcs.initCommand("show") args.append("--abbrev-commit") @@ -1631,7 +1676,8 @@ """ Private slot to show the context menu of the log tree. - @param pos position of the mouse pointer (QPoint) + @param pos position of the mouse pointer + @type QPoint """ self.__logTreeMenu.popup(self.logTree.mapToGlobal(pos)) @@ -1640,8 +1686,10 @@ """ Private slot called, when the current item of the log tree changes. - @param current reference to the new current item (QTreeWidgetItem) - @param previous reference to the old current item (QTreeWidgetItem) + @param current reference to the new current item + @type QTreeWidgetItem + @param previous reference to the old current item + @type QTreeWidgetItem """ self.__updateToolMenuActions() @@ -1710,7 +1758,8 @@ """ Private slot called, when the from date changes. - @param date new date (QDate) + @param date new date + @type QDate """ if self.__actionMode() == "filter": self.__filterLogs() @@ -1720,7 +1769,8 @@ """ Private slot called, when the from date changes. - @param date new date (QDate) + @param date new date + @type QDate """ if self.__actionMode() == "filter": self.__filterLogs() @@ -1741,7 +1791,8 @@ """ Private slot called, when a filter expression is entered. - @param txt filter expression (string) + @param txt filter expression + @type str """ if self.__actionMode() == "filter": self.__filterLogs() @@ -1761,7 +1812,8 @@ """ Private slot called, when the stop on copy/move checkbox is clicked. - @param checked flag indicating the state of the check box (boolean) + @param checked flag indicating the state of the check box + @type bool """ self.vcs.getPlugin().setPreferences( "StopLogOnCopy", self.stopCheckBox.isChecked() @@ -2014,7 +2066,8 @@ """ Private slot to show/hide the committer columns. - @param on flag indicating the selection state (boolean) + @param on flag indicating the selection state + @type bool """ self.logTree.setColumnHidden(self.CommitterColumn, not on) self.logTree.setColumnHidden(self.CommitDateColumn, not on) @@ -2026,7 +2079,8 @@ """ Private slot to show/hide the committer columns. - @param on flag indicating the selection state (boolean) + @param on flag indicating the selection state + @type bool """ self.logTree.setColumnHidden(self.AuthorColumn, not on) self.logTree.setColumnHidden(self.DateColumn, not on) @@ -2038,7 +2092,8 @@ """ Private slot to show/hide the commit ID column. - @param on flag indicating the selection state (boolean) + @param on flag indicating the selection state + @type bool """ self.logTree.setColumnHidden(self.CommitIdColumn, not on) self.vcs.getPlugin().setPreferences("ShowCommitIdColumn", on) @@ -2049,7 +2104,8 @@ """ Private slot to show/hide the branches column. - @param on flag indicating the selection state (boolean) + @param on flag indicating the selection state + @type bool """ self.logTree.setColumnHidden(self.BranchColumn, not on) self.vcs.getPlugin().setPreferences("ShowBranchesColumn", on) @@ -2060,7 +2116,8 @@ """ Private slot to show/hide the tags column. - @param on flag indicating the selection state (boolean) + @param on flag indicating the selection state + @type bool """ self.logTree.setColumnHidden(self.TagsColumn, not on) self.vcs.getPlugin().setPreferences("ShowTagsColumn", on) @@ -2074,7 +2131,8 @@ """ Private method to get the selected action mode. - @return selected action mode (string, one of filter or find) + @return selected action mode (one of 'filter' or 'find') + @rtype str """ return self.modeComboBox.itemData(self.modeComboBox.currentIndex()) @@ -2083,7 +2141,8 @@ """ Private slot to react on mode changes. - @param index index of the selected entry (integer) + @param index index of the selected entry + @type int """ mode = self.modeComboBox.itemData(index) findMode = mode == "find" @@ -2119,8 +2178,10 @@ """ Private slot to find an item matching the entered criteria. - @param backwards flag indicating to search backwards (boolean) - @param interactive flag indicating an interactive search (boolean) + @param backwards flag indicating to search backwards + @type bool + @param interactive flag indicating an interactive search + @type bool """ self.__findBackwards = backwards @@ -2292,7 +2353,9 @@ Private method to merge the file separator entries. @param fileSeparators list of file separator entries to be merged + @type list of str @return merged list of file separator entries + @rtype list of str """ separators = {} for oldFile, newFile, pos1, pos2 in sorted(fileSeparators): @@ -2310,8 +2373,10 @@ """ Private slot called, when the current item of the files tree changes. - @param current reference to the new current item (QTreeWidgetItem) - @param previous reference to the old current item (QTreeWidgetItem) + @param current reference to the new current item + @type QTreeWidgetItem + @param previous reference to the old current item + @type QTreeWidgetItem """ if current: para = current.data(0, self.__diffFileLineRole)
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitMergeDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitMergeDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,11 +26,16 @@ """ Constructor - @param tagsList list of tags (list of strings) - @param branchesList list of branches (list of strings) - @param currentBranch name of the current branch (string) - @param remoteBranchesList list of remote branches (list of strings) - @param parent reference to the parent widget (QWidget) + @param tagsList list of tags + @type list of str + @param branchesList list of branches + @type list of str + @param currentBranch name of the current branch + @type str + @param remoteBranchesList list of remote branches + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -107,7 +112,8 @@ """ Private slot to handle changes of the ID select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__generateDefaultCommitMessage() self.__updateOK() @@ -117,7 +123,8 @@ """ Private slot to handle changes of the Tag select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__generateDefaultCommitMessage() self.__updateOK() @@ -127,7 +134,8 @@ """ Private slot to handle changes of the Branch select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__generateDefaultCommitMessage() self.__updateOK() @@ -137,7 +145,8 @@ """ Private slot to handle changes of the Remote Branch select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__generateDefaultCommitMessage() self.__updateOK() @@ -147,7 +156,8 @@ """ Private slot to handle changes of the None select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__generateDefaultCommitMessage() @@ -156,7 +166,8 @@ """ Private slot to handle changes of the Commit edit. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__generateDefaultCommitMessage() self.__updateOK() @@ -166,7 +177,8 @@ """ Private slot to handle changes of the Tag combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__generateDefaultCommitMessage() self.__updateOK() @@ -176,7 +188,8 @@ """ Private slot to handle changes of the Branch combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__generateDefaultCommitMessage() self.__updateOK() @@ -186,7 +199,8 @@ """ Private slot to handle changes of the Remote Branch combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__generateDefaultCommitMessage() self.__updateOK() @@ -196,7 +210,8 @@ """ Private slot to handle changes of the Commit select group. - @param checked state of the group (boolean) + @param checked state of the group + @type bool """ self.__generateDefaultCommitMessage() self.__updateOK() @@ -215,8 +230,8 @@ @return tuple naming the revision, a flag indicating that the merge shall be committed, the commit message, a flag indicating that a log summary shall be appended and a flag indicating to show diff - statistics at the end of the merge (string, boolean, string, - boolean, boolean) + statistics at the end of the merge + @rtype tuple of (str, bool, str, bool, bool) """ if self.idButton.isChecked(): rev = self.idEdit.text()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitNewProjectOptionsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitNewProjectOptionsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -32,7 +32,9 @@ Constructor @param vcs reference to the version control object - @param parent parent widget (QWidget) + @type Git + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -72,7 +74,8 @@ """ Private slot to handle a change of the project directory. - @param txt name of the project directory (string) + @param txt name of the project directory + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( bool(txt) @@ -155,7 +158,8 @@ Public slot to retrieve the data entered into the dialog. @return a tuple of a string (project directory) and a dictionary - containing the data entered. + containing the data entered + @rtype tuple of (str, Any) """ self.__saveHistory()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitOptionsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitOptionsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -24,8 +24,11 @@ Constructor @param vcs reference to the version control object + @type Git @param project reference to the project object - @param parent parent widget (QWidget) + @type Project + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -38,6 +41,7 @@ Public slot to retrieve the data entered into the dialog. @return a dictionary containing the data entered + @rtype dict """ vcsdatadict = { "message": self.vcsLogEdit.text(),
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitPatchFilesDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitPatchFilesDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,10 +26,13 @@ """ Constructor - @param rootDir root of the directory tree (string) + @param rootDir root of the directory tree + @type str @param patchCheckData tuple of data as returned by the getData() method - @param parent reference to the parent widget (QWidget) + @type tuple of (list of str, int, bool, bool) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -128,7 +131,8 @@ """ Private method to get the list of patch files. - @return list of patch files (list of string) + @return list of patch files + @rtype list of str """ patchFiles = [] for row in range(self.patchFilesList.count()): @@ -144,7 +148,7 @@ @return tuple of list of patch files, strip count, flag indicating that the patch has inaccurate end-of-file marker and a flag indicating to not trust the line count information - (list of string, integer, boolean, boolean) + @rtype tuple of (list of str, int, bool, bool) """ return ( self.__getPatchFilesList(),
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitPatchStatisticsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitPatchStatisticsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,7 +26,9 @@ Constructor @param vcs reference to the VCS object (Git) - @param parent reference to the parent widget (QWidget) + @type Git + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -43,9 +45,11 @@ """ Public method to start the statistics process. - @param projectDir directory name of the project (string) + @param projectDir directory name of the project + @type str @param patchCheckData tuple of data as returned by the GitPatchFilesDialog.getData() method + @type tuple of (list of str, int, bool, bool) """ from .GitPatchFilesDialog import GitPatchFilesDialog @@ -137,7 +141,8 @@ """ Private method to create a file statistics entry. - @param line string with file statistics data (string) + @param line string with file statistics data + @type str """ insertions, deletions, filename = line.strip().split(None, 2) itm = QTreeWidgetItem(self.changesTreeWidget, [insertions, deletions, filename]) @@ -160,6 +165,6 @@ @return tuple of list of patch files, strip count, flag indicating that the patch has inaccurate end-of-file marker and a flag indicating to not trust the line count information - (list of string, integer, boolean, boolean) + @rtype tuple of (list of str, int, bool, bool) """ return self.__patchCheckData
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitPullDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitPullDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,8 +23,11 @@ Constructor @param vcs reference to the git object - @param repodir directory name of the local repository (string) - @param parent reference to the parent widget (QWidget) + @type Git + @param repodir directory name of the local repository + @type str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -74,7 +77,8 @@ """ Private slot to handle changes of the selected repository. - @param txt current text of the combo box (string) + @param txt current text of the combo box + @type str """ self.remoteEdit.setReadOnly(txt != self.__custom) self.remoteBranchesList.setEnabled(txt != self.__all) @@ -95,7 +99,8 @@ """ Private slot to handle changes of the URL edit. - @param txt current text of the URL edit (string) + @param txt current text of the URL edit + @type str """ self.__updateButtonEnable() @@ -135,7 +140,7 @@ @return tuple of remote name, remote url (for custom remotes), remote branches, a flag indicating to pull from all repositories and a flag indicating to remove obsolete tracking references - (string, string, list of strings, boolean, boolean) + @rtype tuple of (str, str, list of str, bool, bool) """ remote = "" url = ""
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitPushDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitPushDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -28,8 +28,11 @@ Constructor @param vcs reference to the git object - @param repodir directory name of the local repository (string) - @param parent reference to the parent widget (QWidget) + @type Git + @param repodir directory name of the local repository + @type str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -86,7 +89,8 @@ """ Private slot to handle changes of the selected repository. - @param txt current text of the combo box (string) + @param txt current text of the combo box + @type str """ self.remoteEdit.setText(self.__repos[txt]) @@ -111,8 +115,10 @@ """ Private slot handling changes of a branch item. - @param item reference to the changed item (QTreeWidgetItem) - @param column changed column (integer) + @param item reference to the changed item + @type QTreeWidgetItem + @param column changed column + @type int """ if column == GitPushDialog.PushColumn: # step 1: set the item's remote branch, if it is empty @@ -152,7 +158,8 @@ """ Private slot to select/deselect all branch items. - @param state check state of the check box (Qt.CheckState) + @param state check state of the check box + @type Qt.CheckState """ if state != Qt.CheckState.PartiallyChecked: for row in range(self.branchesTree.topLevelItemCount()):
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitReflogBrowserDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitReflogBrowserDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -43,7 +43,9 @@ Constructor @param vcs reference to the vcs object - @param parent reference to the parent widget (QWidget) + @type Git + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -95,7 +97,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.__process is not None @@ -138,11 +141,16 @@ """ Private method to generate a reflog tree entry. - @param commitId commit id info (string) - @param selector selector info (string) - @param name name info (string) - @param subject subject of the reflog entry (string) - @return reference to the generated item (QTreeWidgetItem) + @param commitId commit id info + @type str + @param selector selector info + @type str + @param name name info + @type str + @param subject subject of the reflog entry + @type str + @return reference to the generated item + @rtype QTreeWidgetItem """ try: operation, subject = subject.strip().split(": ", 1) @@ -164,7 +172,8 @@ """ Private method to retrieve reflog entries from the repository. - @param skip number of reflog entries to skip (integer) + @param skip number of reflog entries to skip + @type int """ self.refreshButton.setEnabled(False) self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setEnabled(False) @@ -211,7 +220,8 @@ """ Public slot to start the git log command. - @param projectdir directory name of the project (string) + @param projectdir directory name of the project + @type str """ self.errorGroup.hide() QApplication.processEvents() @@ -235,8 +245,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__processBuffer() self.__finish() @@ -348,7 +360,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out) @@ -358,7 +371,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -386,7 +400,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -425,7 +440,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitRemoteRepositoriesDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitRemoteRepositoriesDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -35,7 +35,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Git + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -82,9 +84,12 @@ """ Private method to generate a status item in the status list. - @param name name of the remote repository (string) - @param url URL of the remote repository (string) - @param oper operation the remote repository may be used for (string) + @param name name of the remote repository + @type str + @param url URL of the remote repository + @type str + @param oper operation the remote repository may be used for + @type str """ foundItems = self.repolist.findItems(name, Qt.MatchFlag.MatchExactly, 0) if foundItems: @@ -97,7 +102,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.process is not None @@ -113,7 +119,8 @@ """ Public slot to start the git remote command. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ self.repolist.clear() @@ -200,7 +207,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -214,8 +222,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__finish() @@ -256,7 +266,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -294,7 +305,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitRevisionSelectionDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitRevisionSelectionDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -31,14 +31,20 @@ """ Constructor - @param tagsList list of tags (list of strings) - @param branchesList list of branches (list of strings) - @param trackingBranchesList list of remote branches (list of strings) - @param noneLabel label text for "no revision selected" (string) + @param tagsList list of tags + @type list of str + @param branchesList list of branches + @type list of str + @param trackingBranchesList list of remote branches + @type list of str + @param noneLabel label text for "no revision selected" + @type str @param showBranches flag indicating to show the branch selection - (boolean) - @param showHead flag indicating to show the head selection (boolean) - @param parent parent widget (QWidget) + @type bool + @param showHead flag indicating to show the head selection + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -85,7 +91,8 @@ """ Private slot to handle changes of the rev select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -94,7 +101,8 @@ """ Private slot to handle changes of the Tag select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -103,7 +111,8 @@ """ Private slot to handle changes of the Branch select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -112,7 +121,8 @@ """ Private slot to handle changes of the Remote Branch select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -121,7 +131,8 @@ """ Private slot to handle changes of the rev edit. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__updateOK() @@ -130,7 +141,8 @@ """ Private slot to handle changes of the Tag combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -139,7 +151,8 @@ """ Private slot to handle changes of the Branch combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -148,7 +161,8 @@ """ Private slot to handle changes of the Remote Branch combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -156,7 +170,8 @@ """ Public method to retrieve the selected revision. - @return selected revision (string) + @return selected revision + @rtype str """ if self.revButton.isChecked(): rev = self.revEdit.text()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitRevisionsSelectionDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitRevisionsSelectionDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,9 +23,12 @@ """ Constructor - @param tagsList list of tags (list of strings) - @param branchesList list of branches (list of strings) - @param parent parent widget of the dialog (QWidget) + @param tagsList list of tags + @type list of str + @param branchesList list of branches + @type list of str + @param parent parent widget of the dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -66,7 +69,8 @@ """ Private slot to handle changes of the rev1 select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -75,7 +79,8 @@ """ Private slot to handle changes of the rev2 select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -84,7 +89,8 @@ """ Private slot to handle changes of the Tag1 select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -93,7 +99,8 @@ """ Private slot to handle changes of the Tag2 select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -102,7 +109,8 @@ """ Private slot to handle changes of the Branch1 select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -111,7 +119,8 @@ """ Private slot to handle changes of the Branch2 select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -120,7 +129,8 @@ """ Private slot to handle changes of the rev1 edit. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__updateOK() @@ -129,7 +139,8 @@ """ Private slot to handle changes of the rev2 edit. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__updateOK() @@ -138,7 +149,8 @@ """ Private slot to handle changes of the Tag1 combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -147,7 +159,8 @@ """ Private slot to handle changes of the Tag2 combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -156,7 +169,8 @@ """ Private slot to handle changes of the Branch1 combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -165,7 +179,8 @@ """ Private slot to handle changes of the Branch2 combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -174,7 +189,9 @@ Private method to generate the revision. @param no revision number to generate (1 or 2) - @return revision (string) + @type int + @return revision + @rtype str """ if no == 1: revButton = self.rev1Button @@ -216,7 +233,8 @@ """ Public method to get the revisions. - @return list of two revisions (list of strings) + @return list of two revisions + @rtype list of str """ rev1 = self.__getRevision(1) rev2 = self.__getRevision(2)
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitStashBrowserDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitStashBrowserDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -48,7 +48,9 @@ Constructor @param vcs reference to the vcs object - @param parent reference to the parent widget (QWidget) + @type Git + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -104,7 +106,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.__process is not None @@ -145,9 +148,12 @@ """ Private method to generate the stash items. - @param name name of the stash (string) - @param date date the stash was created (string) - @param message stash message (string) + @param name name of the stash + @type str + @param date date the stash was created + @type str + @param message stash message + @type str """ QTreeWidgetItem(self.stashList, [name, date, message]) @@ -196,7 +202,8 @@ """ Public slot to start the git stash command. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ self.errorGroup.hide() QApplication.processEvents() @@ -220,8 +227,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__processBuffer() self.__finish() @@ -293,7 +302,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -308,8 +318,10 @@ """ Private slot called, when the current item of the stash list changes. - @param current reference to the new current item (QTreeWidgetItem) - @param previous reference to the old current item (QTreeWidgetItem) + @param current reference to the new current item + @type QTreeWidgetItem + @param previous reference to the old current item + @type QTreeWidgetItem """ self.statisticsList.clear() self.filesLabel.setText("") @@ -395,7 +407,8 @@ """ Private slot to show the context menu of the stash list. - @param pos position of the mouse pointer (QPoint) + @param pos position of the mouse pointer + @type QPoint """ enable = len(self.stashList.selectedItems()) == 1 self.__differencesAct.setEnabled(enable) @@ -448,7 +461,8 @@ """ Private slot to handle the password checkbox toggled. - @param checked flag indicating the status of the check box (boolean) + @param checked flag indicating the status of the check box + @type bool """ if checked: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -459,7 +473,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitStashDataDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitStashDataDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -25,7 +25,8 @@ """ Constructor - @param parent reference to the parent widget (QWidget) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -37,9 +38,10 @@ """ Public method to get the user data. - @return tuple containing the message (string), a flag indicating to - keep changes in the staging area (boolean) and an indication to - stash untracked and/or ignored files (integer) + @return tuple containing the message, a flag indicating to keep changes + in the staging area and an indication to stash untracked and/or + ignored files + @rtype tuple of (str, bool, int) """ if self.noneRadioButton.isChecked(): untracked = self.NoUntracked
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitStatusDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitStatusDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -51,7 +51,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Git + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -279,7 +281,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.process is not None @@ -335,8 +338,10 @@ """ Private method to generate a status item in the status list. - @param status status indicator (string) - @param path path of the file or directory (string) + @param status status indicator + @type str + @param path path of the file or directory + @type str """ statusWorkText = self.status[status[1]] statusIndexText = self.status[status[0]] @@ -382,7 +387,7 @@ Public slot to start the git status command. @param fn filename(s)/directoryname(s) to show the status of - (string or list of strings) + @type str or list of str """ self.errorGroup.hide() self.intercept = False @@ -477,7 +482,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -491,8 +497,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__finish() @@ -534,7 +542,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -572,7 +581,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False @@ -663,7 +673,8 @@ """ Private slot to handle the Commit context menu entry. - @param amend flag indicating to perform an amend operation (boolean) + @param amend flag indicating to perform an amend operation + @type bool """ names = [ os.path.join(self.dname, itm.text(self.__pathColumn)) @@ -949,6 +960,7 @@ Private method to retrieve all entries the user wants to commit. @return list of all items, the user has checked + @rtype list of QTreeWidgetItem """ commitableItems = [] for index in range(self.statusList.topLevelItemCount()): @@ -963,6 +975,7 @@ selected. @return list of all items, the user has not checked + @rtype list of QTreeWidgetItem """ items = [] for index in range(self.statusList.topLevelItemCount()): @@ -979,6 +992,7 @@ Private method to retrieve all entries, that have a modified status. @return list of all items with a modified status + @rtype list of QTreeWidgetItem """ modifiedItems = [] for itm in self.statusList.selectedItems(): @@ -994,6 +1008,7 @@ Private method to retrieve all entries, that have a modified status. @return list of all items with a modified status + @rtype list of QTreeWidgetItem """ modifiedItems = [] for itm in self.statusList.selectedItems(): @@ -1010,6 +1025,7 @@ status. @return list of all items with an unversioned status + @rtype list of QTreeWidgetItem """ unversionedItems = [] for itm in self.statusList.selectedItems(): @@ -1023,6 +1039,7 @@ status. @return list of all items with a stageable status + @rtype list of QTreeWidgetItem """ stageableItems = [] for itm in self.statusList.selectedItems(): @@ -1039,6 +1056,7 @@ status. @return list of all items with an unstageable status + @rtype list of QTreeWidgetItem """ unstageableItems = [] for itm in self.statusList.selectedItems(): @@ -1051,6 +1069,7 @@ Private method to retrieve all entries, that have a missing status. @return list of all items with a missing status + @rtype list of QTreeWidgetItem """ missingItems = [] for itm in self.statusList.selectedItems(): @@ -1063,6 +1082,7 @@ Private method to retrieve all entries, that have a conflict status. @return list of all items with a conflict status + @rtype list of QTreeWidgetItem """ conflictingItems = [] for itm in self.statusList.selectedItems(): @@ -1074,7 +1094,8 @@ """ Private slot to select or deselect all entries. - @param selected commit selection state to be set (boolean) + @param selected commit selection state to be set + @type bool """ for index in range(self.statusList.topLevelItemCount()): itm = self.statusList.topLevelItem(index) @@ -1146,7 +1167,8 @@ """ Private slot to show the context menu of the status list. - @param coord position of the mouse pointer (QPoint) + @param coord position of the mouse pointer + @type QPoint """ if bool(self.lDiffEdit.toPlainText()): cursor = self.lDiffEdit.textCursor() @@ -1170,7 +1192,8 @@ """ Private slot to show the context menu of the status list. - @param coord position of the mouse pointer (QPoint) + @param coord position of the mouse pointer + @type QPoint """ if bool(self.rDiffEdit.toPlainText()): cursor = self.rDiffEdit.textCursor() @@ -1269,8 +1292,10 @@ """ Private method to extract the indexes of the selected lines. - @param diffEdit reference to the edit widget (QTextEdit) - @return tuple of start and end indexes (integer, integer) + @param diffEdit reference to the edit widget + @type QTextEdit + @return tuple of start and end indexes + @rtype tuple of (int, int) """ cursor = diffEdit.textCursor() selectionStart = cursor.selectionStart() @@ -1294,7 +1319,8 @@ """ Private method to generate a temporary patch file. - @return name of the temporary file (string) + @return name of the temporary file + @rtype str """ prefix = "eric-git-{0}-".format(os.getpid()) suffix = "-patch"
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitStatusMonitorThread.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitStatusMonitorThread.py Sat Dec 23 15:40:23 2023 +0100 @@ -24,10 +24,14 @@ """ Constructor - @param interval new interval in seconds (integer) - @param project reference to the project object (Project) + @param interval new interval in seconds + @type int + @param project reference to the project object + @type Project @param vcs reference to the version control object - @param parent reference to the parent object (QObject) + @type Git + @param parent reference to the parent object + @type QObject """ VcsStatusMonitorThread.__init__(self, interval, project, vcs, parent) @@ -56,8 +60,9 @@ <li>" " path is back at normal</li> </ul> - @return tuple of flag indicating successful operation (boolean) and - a status message in case of non successful operation (string) + @return tuple of flag indicating successful operation and a status message + in case of non successful operation + @rtype tuple of (bool, str) """ self.shouldUpdate = False
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitSubmodulesStatusDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitSubmodulesStatusDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -156,7 +156,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitTagDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitTagDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -30,10 +30,14 @@ """ Constructor - @param taglist list of previously entered tags (list of strings) - @param revision revision to set tag for (string) - @param tagName name of the tag (string) - @param parent parent widget (QWidget) + @param taglist list of previously entered tags + @type list of str + @param revision revision to set tag for + @type str + @param tagName name of the tag + @type str + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -66,7 +70,8 @@ """ Private method used to enable/disable the OK-button. - @param text tag name entered in the combo (string) + @param text tag name entered in the combo + @type str """ self.okButton.setDisabled(text == "") @@ -74,8 +79,9 @@ """ Public method to retrieve the tag data. - @return tuple of two strings, two int and a boolean (tag, revision, - tag operation, tag type, enforce operation) + @return tuple containing the tag, revision, tag operation, tag type, + and a flag indicating to enforce the operation + @rtype tuple of (str, str, int, int, bool) """ tag = self.tagCombo.currentText().replace(" ", "_")
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitUserConfigDataDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitUserConfigDataDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -21,8 +21,10 @@ """ Constructor - @param version Git version info (tuple of two integers) - @param parent reference to the parent widget (QWidget) + @param version Git version info + @type tuple of (int, int) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -35,7 +37,7 @@ Public method to retrieve the entered data. @return tuple with user's first name, last name and email address - (tuple of three strings) + @rtype tuple of (str, str, str) """ return ( self.firstNameEdit.text(),
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitUtilities.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitUtilities.py Sat Dec 23 15:40:23 2023 +0100 @@ -18,7 +18,8 @@ """ Public function to get the filename of the config file. - @return filename of the config file (string) + @return filename of the config file + @rtype str """ if OSUtilities.isWindowsPlatform(): userprofile = os.environ["USERPROFILE"] @@ -32,8 +33,10 @@ """ Public function to prepare the given process. - @param proc reference to the process to be prepared (QProcess) - @param language language to be set (string) + @param proc reference to the process to be prepared + @type QProcess + @param language language to be set + @type str """ env = QProcessEnvironment.systemEnvironment()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitWorktreeDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitWorktreeDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -136,7 +136,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.__process is not None @@ -359,8 +360,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__finish()
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/ProjectBrowserHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/ProjectBrowserHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -36,12 +36,18 @@ Constructor @param vcsObject reference to the vcs object + @type Git @param browserObject reference to the project browser object + @type ProjectBaseBrowser @param projectObject reference to the project object + @type Project @param isTranslationsBrowser flag indicating, the helper is requested for the translations browser (this needs some special treatment) - @param parent parent widget (QWidget) - @param name name of this object (string) + @type bool + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ VcsProjectBrowserHelper.__init__( self, @@ -61,8 +67,10 @@ VCS status and the file status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ if self.browser.currentItem().data(1) == self.vcs.vcsName(): for act in self.vcsMenuActions: @@ -86,8 +94,10 @@ VCS status and the files status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ vcsName = self.vcs.vcsName() items = self.browser.getSelectedItems() @@ -120,8 +130,10 @@ VCS status and the directory status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ if self.browser.currentItem().data(1) == self.vcs.vcsName(): for act in self.vcsDirMenuActions: @@ -142,8 +154,10 @@ VCS status and the directory status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ vcsName = self.vcs.vcsName() items = self.browser.getSelectedItems() @@ -177,6 +191,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ self.vcsMenuActions = [] self.vcsAddMenuActions = [] @@ -318,6 +333,7 @@ project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ self.vcsMultiMenuActions = [] @@ -422,6 +438,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return @@ -466,6 +483,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return @@ -580,6 +598,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -29,9 +29,13 @@ Constructor @param vcsObject reference to the vcs object + @type Git @param projectObject reference to the project object - @param parent parent widget (QWidget) - @param name name of this object (string) + @type Project + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ VcsProjectHelper.__init__(self, vcsObject, projectObject, parent, name) @@ -40,7 +44,9 @@ Public method to set references to the vcs and project objects. @param vcsObject reference to the vcs object + @type Git @param projectObject reference to the project object + @type Project """ self.vcs = vcsObject self.project = projectObject @@ -49,7 +55,8 @@ """ Public method to get a reference to the project object. - @return reference to the project object (Project) + @return reference to the project object + @rtype Project """ return self.project @@ -57,7 +64,8 @@ """ Public method to get a list of all actions. - @return list of all actions (list of EricAction) + @return list of all actions + @rtype list of EricAction """ actions = self.actions[:] return actions @@ -1747,7 +1755,8 @@ """ Public method to generate the VCS menu. - @param menu reference to the menu to be populated (QMenu) + @param menu reference to the menu to be populated + @type QMenu """ menu.clear() @@ -1949,9 +1958,10 @@ """ Public slot to initialize the VCS toolbar. - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ self.__toolbar = QToolBar(self.tr("Git"), ui) self.__toolbar.setObjectName("GitToolbar") @@ -1993,9 +2003,10 @@ """ Public method to remove a toolbar created by initToolbar(). - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ ui.removeToolBar(self.__toolbar) ui.unregisterToolbar("git")
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/git.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsGit/git.py Sat Dec 23 15:40:23 2023 +0100 @@ -44,8 +44,11 @@ Constructor @param plugin reference to the plugin object - @param parent parent widget (QWidget) - @param name name of this object (string) + @type VcsGitPlugin + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ VersionControl.__init__(self, parent, name) self.defaultOptions = { @@ -112,7 +115,8 @@ """ Public method to get a reference to the plugin object. - @return reference to the plugin object (VcsGitPlugin) + @return reference to the plugin object + @rtype VcsGitPlugin """ return self.__plugin @@ -165,8 +169,10 @@ """ Public method to initialize a command arguments list. - @param command command name (string) - @return list of command options (list of string) + @param command command name + @type str + @return list of command options + @rtype list of str """ args = [command] return args @@ -175,8 +181,8 @@ """ Public method used to test for the presence of the git executable. - @return flag indicating the existance (boolean) and an error message - (string) + @return flag indicating the existance and an error message + @rtype tuple of (bool, str) """ self.versionStr = "" errMsg = "" @@ -224,9 +230,12 @@ Git controlled project. Therefore we always return TRUE without doing anything. - @param vcsDir name of the VCS directory (string) - @param noDialog flag indicating quiet operations (boolean) - @return always TRUE + @param vcsDir name of the VCS directory + @type str + @param noDialog flag indicating quiet operations + @type bool + @return always True + @rtype bool """ return True @@ -264,7 +273,7 @@ @param vcsDataDict dictionary of data required for the import @type dict - @param projectDir project directory (string) + @param projectDir project directory @type str @param noDialog flag indicating quiet operations @type bool @@ -318,9 +327,13 @@ (clone). @param vcsDataDict dictionary of data required for the checkout - @param projectDir project directory to create (string) + @type dict + @param projectDir project directory to create + @type str @param noDialog flag indicating quiet operations - @return flag indicating an execution without errors (boolean) + @type bool + @return flag indicating an execution without errors + @rtype bool """ noDialog = False vcsUrl = self.gitNormalizeURL(vcsDataDict["url"]) @@ -343,8 +356,11 @@ Public method used to export a directory from the Git repository. @param vcsDataDict dictionary of data required for the checkout - @param projectDir project directory to create (string) - @return flag indicating an execution without errors (boolean) + @type dict + @param projectDir project directory to create + @type str + @return flag indicating an execution without errors + @rtype bool """ status = self.vcsCheckout(vcsDataDict, projectDir) adminPath = os.path.join(projectDir, self.adminDirOrFile) @@ -361,12 +377,16 @@ Public method used to make the change of a file/directory permanent in the Git repository. - @param name file/directory name to be committed (string or list of - strings) - @param message message for this operation (string) - @param noDialog flag indicating quiet operations (boolean) - @param commitAll flag indicating to commit all local changes (boolean) - @param amend flag indicating to amend the HEAD commit (boolean) + @param name file/directory name to be committed + @type str or list of str + @param message message for this operation + @type str + @param noDialog flag indicating quiet operations + @type bool + @param commitAll flag indicating to commit all local changes + @type bool + @param amend flag indicating to amend the HEAD commit + @type bool """ from .GitCommitDialog import GitCommitDialog @@ -532,12 +552,14 @@ Public method used to update a file/directory with the Git repository. - @param name file/directory name to be updated (string or list of - strings) - @param noDialog flag indicating quiet operations (boolean) - @param revision revision to update to (string) - @return flag indicating, that the update contained an add - or delete (boolean) + @param name file/directory name to be updated + @type str or list of str + @param noDialog flag indicating quiet operations + @type bool + @param revision revision to update to + @type str + @return flag indicating, that the update contained an add or delete + @rtype bool """ args = self.initCommand("checkout") if revision: @@ -584,9 +606,12 @@ """ Public method used to add a file/directory to the Git repository. - @param name file/directory name to be added (string) - @param isDir flag indicating name is a directory (boolean) + @param name file/directory name to be added + @type str + @param isDir flag indicating name is a directory + @type bool @param noDialog flag indicating quiet operations + @type bool """ args = self.initCommand("add") args.append("-v") @@ -627,8 +652,10 @@ Public method used to add a file/directory in binary mode to the Git repository. - @param name file/directory name to be added (string) - @param isDir flag indicating name is a directory (boolean) + @param name file/directory name to be added + @type str + @param isDir flag indicating name is a directory + @type bool """ self.vcsAdd(name, isDir) @@ -637,8 +664,8 @@ Public method to add a directory tree rooted at path to the Git repository. - @param path root directory of the tree to be added (string or list of - strings)) + @param path root directory of the tree to be added + @type str or list of str """ self.vcsAdd(path, isDir=False) @@ -651,14 +678,17 @@ The default operation is to remove the local copy as well. - @param name file/directory name to be removed (string or list of - strings)) - @param project flag indicating deletion of a project tree (boolean) - (not needed) - @param noDialog flag indicating quiet operations (boolean) + @param name file/directory name to be removed + @type str or list of str + @param project flag indicating deletion of a project tree + @type bool + @param noDialog flag indicating quiet operations + @type bool @param stageOnly flag indicating to just remove the file from the - staging area (boolean) - @return flag indicating successful operation (boolean) + staging area + @type bool + @return flag indicating successful operation + @rtype bool """ args = self.initCommand("rm") if noDialog and "--force" not in args: @@ -712,11 +742,16 @@ """ Public method used to move a file/directory. - @param name file/directory name to be moved (string) + @param name file/directory name to be moved + @type str @param project reference to the project object - @param target new name of the file/directory (string) + @type Project + @param target new name of the file/directory + @type str @param noDialog flag indicating quiet operations - @return flag indicating successful operation (boolean) + @type bool + @return flag indicating successful operation + @rtype bool """ from .GitCopyDialog import GitCopyDialog @@ -774,9 +809,10 @@ Public method used to browse the log of a file/directory from the Git repository. - @param name file/directory name to show the log of (string) + @param name file/directory name to show the log of + @type str @param isFile flag indicating log for a file is to be shown - (boolean) + @type bool """ from .GitLogBrowserDialog import GitLogBrowserDialog @@ -790,7 +826,8 @@ """ Public method used to browse the reflog of the project. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ from .GitReflogBrowserDialog import GitReflogBrowserDialog @@ -810,7 +847,8 @@ being edited and has unsaved modification, they can be saved or the operation may be aborted. - @param name file/directory name to be diffed (string) + @param name file/directory name to be diffed + @type str """ from .GitDiffDialog import GitDiffDialog @@ -837,7 +875,7 @@ Git repository. @param name file/directory name(s) to show the status of - (string or list of strings) + @type str or list of str """ from .GitStatusDialog import GitStatusDialog @@ -851,9 +889,10 @@ """ Public method used to unstage a file/directory. - @param name file/directory name to be reverted (string) - @return flag indicating, that the update contained an add - or delete (boolean) + @param name file/directory name to be reverted + @type str + @return flag indicating, that the update contained an add or delete + @rtype bool """ if isinstance(name, list): dname, fnames = self.splitPathList(name) @@ -948,7 +987,8 @@ """ Public method used to merge a URL/revision into the local project. - @param name file/directory name to be merged (string) + @param name file/directory name to be merged + @type str """ from .GitMergeDialog import GitMergeDialog @@ -996,9 +1036,10 @@ Public method used to switch a working directory to a different revision. - @param name directory name to be switched (string) - @return flag indicating, that the switch contained an add - or delete (boolean) + @param name directory name to be switched + @type str + @return flag indicating, that the switch contained an add or delete + @rtype bool """ from .GitRevisionSelectionDialog import GitRevisionSelectionDialog @@ -1025,8 +1066,10 @@ """ Public method used to get the registered state of a file in the vcs. - @param name filename to check (string) - @return a combination of canBeCommited and canBeAdded + @param name filename to check + @type str + @return registered state (one of canBeCommited and canBeAdded) + @rtype int """ if name.endswith(os.sep): name = name[:-1] @@ -1091,10 +1134,14 @@ that the states for all files have been populated by the previous run. @param names dictionary with all filenames to be checked as keys - @param dname directory to check in (string) - @param shortcut flag indicating a shortcut should be taken (boolean) + @type dict + @param dname directory to check in + @type str + @param shortcut flag indicating a shortcut should be taken + @type bool @return the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error + @rtype dict """ if dname.endswith(os.sep): dname = dname[:-1] @@ -1168,7 +1215,8 @@ """ Public method returning the name of the vcs. - @return always 'Git' (string) + @return always 'Git' + @rtype str """ return "Git" @@ -1178,7 +1226,8 @@ This method ensures, that an ignore file exists. - @param project reference to the project (Project) + @param project reference to the project + @type Project """ ppath = project.getProjectPath() if ppath: @@ -1190,7 +1239,8 @@ """ Public method used to cleanup the working directory. - @param name directory name to be cleaned up (string) + @param name directory name to be cleaned up + @type str """ patterns = self.__plugin.getPreferences("CleanupPatterns").split() @@ -1206,7 +1256,8 @@ """ Public method used to execute arbitrary Git commands. - @param name directory name of the working directory (string) + @param name directory name of the working directory + @type str """ from .GitCommandDialog import GitCommandDialog @@ -1241,11 +1292,15 @@ Public method to get a dialog to enter repository info. @param project reference to the project object - @param archive name of the project in the repository (string) + @type Project + @param archive name of the project in the repository + @type str @param editable flag indicating that the project name is editable - (boolean) - @param parent parent widget (QWidget) - @return reference to the instantiated options dialog (GitOptionsDialog) + @type bool + @param parent parent widget + @type QWidget + @return reference to the instantiated options dialog + @rtype GitOptionsDialog """ from .GitOptionsDialog import GitOptionsDialog @@ -1256,9 +1311,10 @@ Public method to get a dialog to enter repository info for getting a new project. - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget @return reference to the instantiated options dialog - (GitNewProjectOptionsDialog) + @rtype GitNewProjectOptionsDialog """ from .GitNewProjectOptionsDialog import GitNewProjectOptionsDialog @@ -1268,8 +1324,10 @@ """ Public method to retrieve information about the repository. - @param ppath local path to get the repository infos (string) - @return string with ready formated info for display (string) + @param ppath local path to get the repository infos + @type str + @return string with ready formated info for display + @rtype str """ formatTemplate = ( "format:" @@ -1394,7 +1452,7 @@ Public method to signal the support of user settable command options. @return flag indicating the support of user settable command options - (boolean) + @rtype bool """ return False @@ -1406,8 +1464,10 @@ """ Public method to normalize a url for Git. - @param url url string (string) - @return properly normalized url for git (string) + @param url url string + @type str + @return properly normalized url for git + @rtype str """ url = url.replace("\\", "/") if url.endswith("/"): @@ -1422,9 +1482,12 @@ """ Public method to create the ignore file. - @param name directory name to create the ignore file in (string) - @param autoAdd flag indicating to add it automatically (boolean) + @param name directory name to create the ignore file in + @type str + @param autoAdd flag indicating to add it automatically + @type bool @return flag indicating success + @rtype bool """ status = False ignorePatterns = [ @@ -1486,9 +1549,12 @@ """ Public method used to copy a file/directory. - @param name file/directory name to be copied (string) + @param name file/directory name to be copied + @type str @param project reference to the project object - @return flag indicating successful operation (boolean) + @type Project + @return flag indicating successful operation + @rtype bool """ from .GitCopyDialog import GitCopyDialog @@ -1562,7 +1628,8 @@ This method gives the chance to enter the revisions to be compared. - @param name file/directory name to be diffed (string) + @param name file/directory name to be diffed + @type str """ from .GitDiffDialog import GitDiffDialog from .GitRevisionsSelectionDialog import GitRevisionsSelectionDialog @@ -1604,9 +1671,12 @@ Private method to get a file for a specific revision from the repository. - @param name file name to get from the repository (string) - @param rev revision to retrieve (string) - @return contents of the file (string) and an error message (string) + @param name file name to get from the repository + @type str + @param rev revision to retrieve + @type str + @return contents of the file (string) and an error message + @rtype str """ # find the root of the repo repodir = self.findRepoRoot(self.splitPath(name)[0]) @@ -1655,9 +1725,12 @@ Public method used to view the difference of a file to the Git repository side-by-side. - @param name file name to be diffed (string) - @param extended flag indicating the extended variant (boolean) - @param revisions tuple of two revisions (tuple of strings) + @param name file name to be diffed + @type str + @param extended flag indicating the extended variant + @type bool + @param revisions tuple of two revisions + @type tuple of (str, str) @exception ValueError raised to indicate an invalid name parameter """ from eric7.UI.CompareDialog import CompareDialog @@ -1727,7 +1800,8 @@ """ Public method to fetch changes from a remote repository. - @param name directory name (string) + @param name directory name + @type str """ from .GitFetchDialog import GitFetchDialog @@ -1773,9 +1847,10 @@ """ Public method used to pull changes from a remote Git repository. - @param name directory name of the project to be pulled to (string) - @return flag indicating, that the update contained an add - or delete (boolean) + @param name directory name of the project to be pulled to + @type str + @return flag indicating, that the update contained an add or delete + @rtype bool """ from .GitPullDialog import GitPullDialog @@ -1813,7 +1888,8 @@ """ Public method used to push changes to a remote Git repository. - @param name directory name of the project to be pushed from (string) + @param name directory name of the project to be pushed from + @type str """ from .GitPushDialog import GitPushDialog @@ -1848,7 +1924,8 @@ """ Public method to commit a failed merge. - @param name file/directory name (string) + @param name file/directory name + @type str """ dname, fname = self.splitPath(name) @@ -1877,9 +1954,10 @@ """ Public method to cancel an uncommitted or failed merge. - @param name file/directory name (string) - @return flag indicating, that the cancellation contained an add - or delete (boolean) + @param name file/directory name + @type str + @return flag indicating, that the cancellation contained an add or delete + @rtype bool """ dname, fname = self.splitPath(name) @@ -1903,12 +1981,16 @@ """ Public method to apply a patch stored in a given file. - @param repodir directory name of the repository (string) - @param patchFile name of the patch file (string) + @param repodir directory name of the repository + @type str + @param patchFile name of the patch file + @type str @param cached flag indicating to apply the patch to the staging area - (boolean) - @param reverse flag indicating to apply the patch in reverse (boolean) - @param noDialog flag indicating quiet operations (boolean) + @type bool + @param reverse flag indicating to apply the patch in reverse + @type bool + @param noDialog flag indicating quiet operations + @type bool """ args = self.initCommand("apply") if cached: @@ -1931,8 +2013,10 @@ Public method to apply a list of patch files or check, if they would apply cleanly. - @param projectDir directory name of the project (string) - @param check flag indicating to perform a check operation (boolean) + @param projectDir directory name of the project + @type str + @param check flag indicating to perform a check operation + @type bool """ from .GitPatchFilesDialog import GitPatchFilesDialog @@ -1976,7 +2060,8 @@ """ Public method to show statistics for a set of patch files. - @param projectDir directory name of the project (string) + @param projectDir directory name of the project + @type str """ from .GitPatchStatisticsDialog import GitPatchStatisticsDialog @@ -1996,10 +2081,13 @@ Public method used to set/remove a tag in the Git repository. @param name file/directory name to determine the repo root from - (string) - @param revision revision to set tag for (string) - @param tagName name of the tag (string) - @return flag indicating a performed tag action (boolean) + @type str + @param revision revision to set tag for + @type str + @param tagName name of the tag + @type str + @return flag indicating a performed tag action + @rtype bool """ from .GitTagDialog import GitTagDialog @@ -2048,10 +2136,11 @@ """ Public method to get the list of tags. - @param repodir directory name of the repository (string) - @return list of tags (list of string) or list of tuples of - tag name and flag indicating a local tag (list of tuple of string - and boolean), if withType is True + @param repodir directory name of the repository + @type str + @return list of tags or list of tuples of tag name and flag indicating + a local tag, if withType is True + @rtype list of str or list of tuple of (str, bool) """ args = self.initCommand("tag") args.append("--list") @@ -2082,12 +2171,15 @@ """ Public method used to list the available tags or branches. - @param path directory name of the project (string) + @param path directory name of the project + @type str @param tags flag indicating listing of branches or tags (False = branches, True = tags) - @param listAll flag indicating to show all tags or branches (boolean) - @param merged flag indicating to show only merged or non-merged - branches (boolean) + @type bool + @param listAll flag indicating to show all tags or branches + @type bool + @param merged flag indicating to show only merged or non-merged branches + @type bool """ from .GitTagBranchListDialog import GitTagBranchListDialog @@ -2110,11 +2202,16 @@ """ Public method to get the list of branches. - @param repodir directory name of the repository (string) - @param withMain flag indicating to get 'main' as well (boolean) - @param allBranches flag indicating to return all branches (boolean) - @param remotes flag indicating to return remote branches only (boolean) - @return list of branches (list of string) + @param repodir directory name of the repository + @type str + @param withMain flag indicating to get 'main' as well + @type bool + @param allBranches flag indicating to return all branches + @type bool + @param remotes flag indicating to return remote branches only + @type bool + @return list of branches + @rtype list of str """ args = self.initCommand("branch") args.append("--list") @@ -2155,8 +2252,10 @@ """ Public method used to show the current branch of the working directory. - @param repodir directory name of the repository (string) - @return name of the current branch (string) + @param repodir directory name of the repository + @type str + @return name of the current branch + @rtype str """ args = self.initCommand("branch") args.append("--list") @@ -2192,13 +2291,17 @@ Public method used to create, delete or move a branch in the Git repository. - @param name file/directory name to be branched (string) - @param revision revision to set tag for (string) - @param branchName name of the branch (string) - @param branchOp desired branch operation (integer) - @return flag indicating a performed branch action (boolean) and - a flag indicating, that the branch operation contained an add - or delete (boolean) + @param name file/directory name to be branched + @type str + @param revision revision to set tag for + @type str + @param branchName name of the branch + @type str + @param branchOp desired branch operation + @type int + @return flag indicating a performed branch action and a flag indicating, + that the branch operation contained an add or delete + @rtype tuple of (bool, bool) """ from .GitBranchDialog import GitBranchDialog @@ -2300,7 +2403,8 @@ """ Public method to delete a branch from a remote repository. - @param name file/directory name (string) + @param name file/directory name + @type str """ from .GitBranchPushDialog import GitBranchPushDialog @@ -2332,7 +2436,8 @@ """ Public method used to show the current branch of the working directory. - @param name file/directory name (string) + @param name file/directory name + @type str """ dname, fname = self.splitPath(name) @@ -2356,7 +2461,8 @@ """ Public method to create a bundle file. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ from .GitBundleDialog import GitBundleDialog @@ -2418,7 +2524,8 @@ """ Public method to verify a bundle file. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -2447,7 +2554,8 @@ """ Public method to list the heads contained in a bundle file. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -2476,9 +2584,12 @@ """ Public method to get a list of heads contained in a bundle file. - @param repodir directory name of the repository (string) - @param bundleFile file name of a git bundle file (string) - @return list of heads (list of strings) + @param repodir directory name of the repository + @type str + @param bundleFile file name of a git bundle file + @type str + @return list of heads + @rtype list of str """ args = self.initCommand("bundle") args.append("list-heads") @@ -2511,7 +2622,8 @@ Public method to fetch a head of a bundle file into the local repository. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ from .GitApplyBundleDataDialog import GitApplyBundleDataDialog @@ -2555,9 +2667,10 @@ Public method to pull a head of a bundle file into the local repository and working area. - @param projectDir name of the project directory (string) - @return flag indicating, that the update contained an add - or delete (boolean) + @param projectDir name of the project directory + @type str + @return flag indicating, that the update contained an add or delete + @rtype bool """ from .GitApplyBundleDataDialog import GitApplyBundleDataDialog @@ -2607,11 +2720,13 @@ """ Public method to perform bisect commands. - @param projectDir name of the project directory (string) - @param subcommand name of the subcommand (string, one of 'start', + @param projectDir name of the project directory + @type str + @param subcommand name of the subcommand (one of 'start', 'start_extended', 'good', 'bad', 'skip' or 'reset') - @return flag indicating, that the update contained an add - or delete (boolean) + @type str + @return flag indicating, that the update contained an add or delete + @rtype bool @exception ValueError raised to indicate an invalid bisect subcommand """ from .GitBisectStartDialog import GitBisectStartDialog @@ -2682,7 +2797,8 @@ """ Public method used to browse the bisect log of the project. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ from .GitBisectLogBrowserDialog import GitBisectLogBrowserDialog @@ -2696,7 +2812,8 @@ """ Public method used to create a bisect replay file for the project. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -2779,7 +2896,8 @@ """ Public method used to edit a bisect replay file. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -2802,9 +2920,10 @@ """ Public method to replay a bisect session. - @param projectDir name of the project directory (string) - @return flag indicating, that the update contained an add - or delete (boolean) + @param projectDir name of the project directory + @type str + @return flag indicating, that the update contained an add or delete + @rtype bool """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -2842,8 +2961,10 @@ """ Public method to get the list of remote repos. - @param repodir directory name of the repository (string) - @return list of remote repos (list of string) + @param repodir directory name of the repository + @type str + @return list of remote repos + @rtype list of str """ args = self.initCommand("remote") @@ -2873,10 +2994,12 @@ """ Public method to get the list of remote repos and their URLs. - @param repodir directory name of the repository (string) - @param forFetch flag indicating to get Fetch info (string) - @return list of tuples of remote repo name and repo URL (list of - tuple of two strings) + @param repodir directory name of the repository + @type str + @param forFetch flag indicating to get Fetch info + @type str + @return list of tuples of remote repo name and repo URL + @rtype list of [(str, str)] """ args = self.initCommand("remote") args.append("--verbose") @@ -2942,9 +3065,12 @@ """ Public method to get the list of a remote repository branches. - @param repodir directory name of the repository (string) - @param remote remote repository name (string) - @return list of remote repository branches (list of string) + @param repodir directory name of the repository + @type str + @param remote remote repository name + @type str + @return list of remote repository branches + @rtype list of str """ args = self.initCommand("ls-remote") args.append("--heads") @@ -2976,8 +3102,10 @@ """ Public method to show information about a remote repository. - @param projectDir name of the project directory (string) - @param remoteName name of the remote repository (string) + @param projectDir name of the project directory + @type str + @param remoteName name of the remote repository + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -2997,7 +3125,8 @@ """ Public method to show available remote repositories. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ from .GitRemoteRepositoriesDialog import GitRemoteRepositoriesDialog @@ -3011,7 +3140,8 @@ """ Public method to add a remote repository. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ from .GitAddRemoteDialog import GitAddRemoteDialog @@ -3034,8 +3164,10 @@ """ Public method to rename a remote repository. - @param projectDir name of the project directory (string) - @param remoteName name of the remote repository (string) + @param projectDir name of the project directory + @type str + @param remoteName name of the remote repository + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3128,8 +3260,10 @@ """ Public method to remove a remote repository. - @param projectDir name of the project directory (string) - @param remoteName name of the remote repository (string) + @param projectDir name of the project directory + @type str + @param remoteName name of the remote repository + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3146,8 +3280,10 @@ """ Public method to prune stale remote-tracking branches. - @param projectDir name of the project directory (string) - @param remoteName name of the remote repository (string) + @param projectDir name of the project directory + @type str + @param remoteName name of the remote repository + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3168,8 +3304,10 @@ Public method to show a short log suitable for inclusion in release announcements. - @param projectDir name of the project directory (string) - @param commit commit to start the log at (strings) + @param projectDir name of the project directory + @type str + @param commit commit to start the log at + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3189,9 +3327,10 @@ """ Public method to find the most recent tag reachable from each commit. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str @param commits list of commits to start the search from - (list of strings) + @type list of str """ from .GitDescribeDialog import GitDescribeDialog @@ -3210,9 +3349,12 @@ Public method to cherry pick commits and apply them to the current branch. - @param projectDir name of the project directory (string) - @param commits list of commits to be applied (list of strings) - @return flag indicating that the project should be reread (boolean) + @param projectDir name of the project directory + @type str + @param commits list of commits to be applied + @type list of str + @return flag indicating that the project should be reread + @rtype bool """ from .GitCherryPickDialog import GitCherryPickDialog @@ -3250,8 +3392,10 @@ Public method to continue the last copying session after conflicts were resolved. - @param projectDir name of the project directory (string) - @return flag indicating that the project should be reread (boolean) + @param projectDir name of the project directory + @type str + @return flag indicating that the project should be reread + @rtype bool """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3280,8 +3424,10 @@ """ Public method to quit the current copying operation. - @param projectDir name of the project directory (string) - @return flag indicating that the project should be reread (boolean) + @param projectDir name of the project directory + @type str + @return flag indicating that the project should be reread + @rtype bool """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3304,8 +3450,10 @@ Public method to cancel the last copying session and return to the previous state. - @param projectDir name of the project directory (string) - @return flag indicating that the project should be reread (boolean) + @param projectDir name of the project directory + @type str + @return flag indicating that the project should be reread + @rtype bool """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3331,8 +3479,10 @@ """ Private method to get a list of stash names. - @param projectDir name of the project directory (string) - @return list of available stashes (list of string) + @param projectDir name of the project directory + @type str + @return list of available stashes + @rtype list of str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3367,9 +3517,10 @@ """ Public method to save the current changes to a new stash. - @param projectDir name of the project directory (string) - @return flag indicating, that the save contained an add - or delete (boolean) + @param projectDir name of the project directory + @type str + @return flag indicating, that the save contained an add or delete + @rtype bool """ from .GitStashDataDialog import GitStashDataDialog @@ -3405,7 +3556,8 @@ """ Public method used to browse the stashed changes. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ from .GitStashBrowserDialog import GitStashBrowserDialog @@ -3419,8 +3571,10 @@ """ Public method to show the contents of a stash. - @param projectDir name of the project directory (string) - @param stashName name of a stash (string) + @param projectDir name of the project directory + @type str + @param stashName name of a stash + @type str """ from .GitDiffDialog import GitDiffDialog @@ -3452,10 +3606,12 @@ """ Public method to apply a stash but keep it. - @param projectDir name of the project directory (string) - @param stashName name of a stash (string) - @return flag indicating, that the restore contained an add - or delete (boolean) + @param projectDir name of the project directory + @type str + @param stashName name of a stash + @type str + @return flag indicating, that the restore contained an add or delete + @rtype bool """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3492,10 +3648,12 @@ """ Public method to apply a stash and delete it. - @param projectDir name of the project directory (string) - @param stashName name of a stash (string) - @return flag indicating, that the restore contained an add - or delete (boolean) + @param projectDir name of the project directory + @type str + @param stashName name of a stash + @type str + @return flag indicating, that the restore contained an add or delete + @rtype bool """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3532,10 +3690,12 @@ """ Public method to create a branch from a stash. - @param projectDir name of the project directory (string) - @param stashName name of a stash (string) - @return flag indicating, that the restore contained an add - or delete (boolean) + @param projectDir name of the project directory + @type str + @param stashName name of a stash + @type str + @return flag indicating, that the restore contained an add or delete + @rtype bool """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3582,9 +3742,12 @@ """ Public method to delete a stash. - @param projectDir name of the project directory (string) - @param stashName name of a stash (string) - @return flag indicating a successful deletion (boolean) + @param projectDir name of the project directory + @type str + @param stashName name of a stash + @type str + @return flag indicating a successful deletion + @rtype bool """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3627,8 +3790,10 @@ """ Public method to delete all stashes. - @param projectDir name of the project directory (string) - @return flag indicating a successful deletion (boolean) + @param projectDir name of the project directory + @type str + @return flag indicating a successful deletion + @rtype bool """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3654,7 +3819,8 @@ """ Public method used to edit the repository configuration file. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3694,7 +3860,8 @@ """ Public method to show the combined configuration. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3714,7 +3881,8 @@ Public method to verify the connectivity and validity of objects of the database. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3735,7 +3903,8 @@ """ Public method to cleanup and optimize the local repository. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3756,7 +3925,8 @@ """ Public method to show some statistics of the local repository. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ # find the root of the repo repodir = self.findRepoRoot(projectDir) @@ -3844,8 +4014,10 @@ """ Public method to get a list of supported archive formats. - @param repodir directory name of the repository (string) - @return list of supported archive formats (list of strings) + @param repodir directory name of the repository + @type str + @return list of supported archive formats + @rtype list of str """ args = self.initCommand("archive") args.append("--list") @@ -3876,7 +4048,8 @@ """ Public method to show some statistics of the local repository. - @param projectDir name of the project directory (string) + @param projectDir name of the project directory + @type str """ from .GitArchiveDataDialog import GitArchiveDataDialog @@ -4297,10 +4470,14 @@ project browsers. @param browser reference to the project browser object + @type ProjectBaseBrowser @param project reference to the project object + @type Project @param isTranslationsBrowser flag indicating, the helper is requested for the translations browser (this needs some special treatment) + @type bool @return the project browser helper object + @rtype GitProjectBrowserHelper """ from .ProjectBrowserHelper import GitProjectBrowserHelper @@ -4311,7 +4488,9 @@ Public method to instantiate a helper object for the project. @param project reference to the project object + @type Project @return the project helper object + @rtype GitProjectHelper """ self.__projectHelper = self.__plugin.getProjectHelper() self.__projectHelper.setObjects(self, project) @@ -4327,9 +4506,11 @@ thread. @param interval check interval for the monitor thread in seconds - (integer) - @param project reference to the project object (Project) - @return reference to the monitor thread (QThread) + @type int + @param project reference to the project object + @type Project + @return reference to the monitor thread + @rtype GitStatusMonitorThread """ from .GitStatusMonitorThread import GitStatusMonitorThread
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/CloseheadExtension/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/CloseheadExtension/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -58,7 +58,8 @@ @param mainMenu reference to the main menu @type QMenu - @return populated menu (QMenu) + @return populated menu + @rtype QMenu """ menu = QMenu(self.menuTitle(), mainMenu) menu.setIcon(EricPixmapCache.getIcon("closehead"))
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ConfigurationPage/MercurialPage.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ConfigurationPage/MercurialPage.py Sat Dec 23 15:40:23 2023 +0100 @@ -33,6 +33,7 @@ Constructor @param plugin reference to the plugin object + @type Hg """ super().__init__() self.setupUi(self)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/GpgExtension/HgGpgSignaturesDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/GpgExtension/HgGpgSignaturesDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -25,7 +25,9 @@ Constructor @param vcs reference to the vcs object - @param parent reference to the parent widget (QWidget) + @type Hg + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -44,7 +46,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -94,7 +97,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -123,9 +127,12 @@ """ Private method to generate a patch item in the list of patches. - @param revision revision number (string) - @param changeset changeset of the bookmark (string) - @param signature signature of the changeset (string) + @param revision revision number + @type str + @param changeset changeset of the bookmark + @type str + @param signature signature of the changeset + @type str """ if revision == "" and changeset == "": QTreeWidgetItem(self.signaturesList, [signature]) @@ -151,7 +158,8 @@ """ Private method to process the lines of output. - @param line output line to be processed (string) + @param line output line to be processed + @type str """ li = line.split() if li[-1][0] in "1234567890": @@ -165,7 +173,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out) @@ -208,7 +217,8 @@ """ Private slot called, when a filter expression is entered. - @param txt filter expression (string) + @param txt filter expression + @type str """ self.__filterSignatures()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/GpgExtension/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/GpgExtension/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -96,8 +96,10 @@ """ Public method to generate the extension menu. - @param mainMenu reference to the main menu (QMenu) - @return populated menu (QMenu) + @param mainMenu reference to the main menu + @type QMenu + @return populated menu + @rtype QMenu """ menu = QMenu(self.menuTitle(), mainMenu) menu.setIcon(EricPixmapCache.getIcon("changesetSign")) @@ -113,7 +115,8 @@ """ Public method to get the menu title. - @return title of the menu (string) + @return title of the menu + @rtype str """ return self.tr("GPG")
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/GpgExtension/gpg.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/GpgExtension/gpg.py Sat Dec 23 15:40:23 2023 +0100 @@ -24,6 +24,7 @@ Constructor @param vcs reference to the Mercurial vcs object + @type Hg """ super().__init__(vcs) @@ -50,7 +51,8 @@ """ Public method used to verify the signatures of a revision. - @param rev revision to check (string) + @param rev revision to check + @type str """ if rev is None: dlg = HgRevisionSelectionDialog(
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgAddSubrepositoryDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgAddSubrepositoryDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -28,8 +28,10 @@ """ Constructor - @param projectPath project directory name (string) - @param parent reference to the parent widget (QWidget) + @param projectPath project directory name + @type str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -63,7 +65,8 @@ """ Private slot to handle the update of the path. - @param p0 text of the path edit (string) + @param p0 text of the path edit + @type str """ self.__updateOk() @@ -72,7 +75,8 @@ """ Private slot to handle the update of the URL. - @param p0 text of the URL edit (string) + @param p0 text of the URL edit + @type str """ self.__updateOk() @@ -100,8 +104,8 @@ Public method to get the data. @return tuple containing the relative path within the project, the - sub-repository type and the sub-repository URL (string, string, - string) + sub-repository type and the sub-repository URL + @rtype tuple of (str, str, str) """ return ( self.pathPicker.text(),
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgAnnotateDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgAnnotateDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -28,7 +28,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Hg + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -55,7 +57,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -146,7 +149,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -168,12 +172,18 @@ """ Private method to generate an annotate item in the annotation list. - @param marker marker character for skipped revisions (string) - @param revision revision string (string) - @param changeset changeset string (string) - @param author author of the change (string) - @param date date of the change (string) - @param text text of the change (string) + @param marker marker character for skipped revisions + @type str + @param revision revision string + @type str + @param changeset changeset string + @type str + @param author author of the change + @type str + @param date date of the change + @type str + @param text text of the change + @type str """ itm = QTreeWidgetItem( self.annotateList, @@ -200,7 +210,8 @@ """ Private method to process the lines of output. - @param line output line to be processed (string) + @param line output line to be processed + @type str """ match = self.__annotateRe.match(line) author, rev, changeset, date, file, marker, text = match.groups() @@ -214,7 +225,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgArchiveDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgArchiveDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,7 +26,9 @@ Constructor @param vcs reference to the Mercurial object (Hg) - @param parent reference to the parent widget (QWidget) + @type Hg + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -83,7 +85,8 @@ """ Private slot to handle changes of the archive name. - @param archive name of the archive (string) + @param archive name of the archive + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( archive != "" @@ -94,7 +97,8 @@ """ Private slot to react on changes of the selected archive type. - @param index index of the selected type (integer) + @param index index of the selected type + @type int """ type_ = self.typeComboBox.itemData(index) if type_ == "files": @@ -112,9 +116,9 @@ """ Public method to retrieve the data. - @return tuple giving the archive name (string), the archive type - (string), the directory prefix 8string) and a flag indicating - to recurse into subrepositories (boolean) + @return tuple giving the archive name, the archive type, the directory prefix + and a flag indicating to recurse into subrepositories + @rtype tuple of (str, str, str, bool) """ return ( self.archivePicker.text(),
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgBookmarkRenameDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgBookmarkRenameDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,8 +22,10 @@ """ Constructor - @param bookmarksList list of bookmarks (list of strings) - @param parent reference to the parent widget (QWidget) + @param bookmarksList list of bookmarks + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -48,7 +50,8 @@ """ Private slot to handle changes of the bookmark name. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__updateUI() @@ -57,7 +60,8 @@ """ Private slot to handle changes of the selected bookmark. - @param txt name of the selected bookmark (string) + @param txt name of the selected bookmark + @type str """ self.__updateUI() @@ -66,7 +70,7 @@ Public method to retrieve the entered data. @return tuple naming the old and new bookmark names - (string, string) + @rtype tuple of (str, str) """ return ( self.bookmarkCombo.currentText().replace(" ", "_"),
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgBookmarksInOutDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgBookmarksInOutDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -27,9 +27,12 @@ Constructor @param vcs reference to the vcs object + @type Hg @param mode mode of the dialog (HgBookmarksInOutDialog.INCOMING, HgBookmarksInOutDialog.OUTGOING) - @param parent reference to the parent widget (QWidget) + @type int + @param parent reference to the parent widget + @type QWidget @exception ValueError raised to indicate an invalid dialog mode """ super().__init__(parent) @@ -60,7 +63,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -121,7 +125,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -153,8 +158,10 @@ """ Private method to generate a bookmark item in the bookmarks list. - @param changeset changeset of the bookmark (string) - @param name name of the bookmark (string) + @param changeset changeset of the bookmark + @type str + @param name name of the bookmark + @type str """ QTreeWidgetItem(self.bookmarksList, [name, changeset]) @@ -162,7 +169,8 @@ """ Private method to process the lines of output. - @param line output line to be processed (string) + @param line output line to be processed + @type str """ if line.startswith(" "): li = line.strip().split() @@ -175,7 +183,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgBookmarksListDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgBookmarksListDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -35,7 +35,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Hg + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -65,7 +67,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -77,7 +80,7 @@ Public slot to start the bookmarks command. @param bookmarksList reference to string list receiving the bookmarks - (list of strings) + @type list of str """ self.bookmarksList.clear() self.__bookmarksDefined = False @@ -142,7 +145,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -176,10 +180,14 @@ """ Private method to generate a bookmark item in the bookmarks list. - @param revision revision of the bookmark (string) - @param changeset changeset of the bookmark (string) - @param status of the bookmark (string) - @param name name of the bookmark (string) + @param revision revision of the bookmark + @type str + @param changeset changeset of the bookmark + @type str + @param status of the bookmark + @type str + @param name name of the bookmark + @type str """ itm = QTreeWidgetItem(self.bookmarksList) if revision[0].isdecimal(): @@ -199,7 +207,8 @@ """ Private method to process the lines of output. - @param line output line to be processed (string) + @param line output line to be processed + @type str """ li = line.split() if li[-1][0] in "1234567890": @@ -220,7 +229,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgBranchInputDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgBranchInputDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,8 +23,9 @@ Constructor @param branches branch names to populate the branch list with - (list of string) - @param parent reference to the parent widget (QWidget) + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -42,7 +43,8 @@ """ Private slot handling a change of the branch name. - @param txt contents of the branch combo box (string) + @param txt contents of the branch combo box + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled(bool(txt))
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgBundleDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgBundleDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -75,7 +75,8 @@ """ Private slot to handle changes of the Multiple select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -84,7 +85,8 @@ """ Private slot to handle changes of the Tag select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -93,7 +95,8 @@ """ Private slot to handle changes of the Branch select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -102,7 +105,8 @@ """ Private slot to handle changes of the Bookmark select button. - @param checked state of the button (boolean) + @param checked state of the button + @type bool """ self.__updateOK() @@ -118,7 +122,8 @@ """ Private slot to handle changes of the Tag combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -127,7 +132,8 @@ """ Private slot to handle changes of the Branch combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -136,7 +142,8 @@ """ Private slot to handle changes of the Bookmark combo. - @param txt text of the combo (string) + @param txt text of the combo + @type str """ self.__updateOK() @@ -145,8 +152,8 @@ Public method to retrieve the bundle data. @return tuple naming the revisions, base revisions, the compression - type and a flag indicating to bundle all changesets (string, - string, boolean) + type and a flag indicating to bundle all changesets + @rtype tuple of (str, str, bool) """ if self.multipleButton.isChecked(): revs = [
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgClientPromptDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgClientPromptDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,9 +23,12 @@ """ Constructor - @param size maximum length of the requested input (integer) - @param message message sent by the server (string) - @param parent reference to the parent widget (QWidget) + @param size maximum length of the requested input + @type int + @param message message sent by the server + @type str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -47,7 +50,8 @@ """ Private slot to handle changes of the user input. - @param txt text entered by the user (string) + @param txt text entered by the user + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled(bool(txt)) @@ -56,7 +60,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.inputEdit.setEchoMode(QLineEdit.EchoMode.Password) @@ -67,7 +72,8 @@ """ Public method to get the user input. - @return user input (string) + @return user input + @rtype str """ return self.inputEdit.text()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgCommandDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgCommandDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -28,9 +28,12 @@ """ Constructor - @param argvList history list of commandline arguments (list of strings) - @param ppath pathname of the project directory (string) - @param parent parent widget of this dialog (QWidget) + @param argvList history list of commandline arguments + @type list of str + @param ppath pathname of the project directory + @type str + @param parent parent widget of this dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -62,6 +65,7 @@ Private method used to enable/disable the OK-button. @param text ignored + @type str """ self.okButton.setDisabled(self.commandCombo.currentText() == "") @@ -69,6 +73,7 @@ """ Public method to retrieve the data entered into this dialog. - @return commandline parameters (string) + @return commandline parameters + @rtype str """ return self.commandCombo.currentText()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgCommitDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgCommitDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -31,10 +31,15 @@ Constructor @param vcs reference to the vcs object - @param msg initial message (string) - @param mq flag indicating a queue commit (boolean) - @param merge flag indicating a merge commit (boolean) - @param parent parent widget (QWidget) + @type Hg + @param msg initial message + @type str + @param mq flag indicating a queue commit + @type bool + @param merge flag indicating a merge commit + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent, Qt.WindowType.Window) self.setupUi(self) @@ -57,7 +62,8 @@ """ Protected method called when the dialog is about to be shown. - @param evt the event (QShowEvent) + @param evt the event + @type QShowEvent """ commitMessages = self.__vcs.vcsCommitMessages() self.recentComboBox.clear() @@ -81,7 +87,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel): self.logEdit.clear()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgConflictsListDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgConflictsListDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -38,7 +38,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Hg + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -66,7 +68,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -137,7 +140,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -168,8 +172,10 @@ """ Private method to generate a tag item in the tag list. - @param status status of the file (string) - @param name name of the file (string) + @param status status of the file + @type str + @param name name of the file + @type str """ itm = QTreeWidgetItem(self.conflictsList) if status == "U": @@ -187,7 +193,8 @@ """ Private method to process the lines of output. - @param line output line to be processed (string) + @param line output line to be processed + @type str """ status, filename = line.strip().split(None, 1) self.__generateItem(status, filename) @@ -196,7 +203,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out) @@ -219,8 +227,10 @@ """ Private slot to open the double clicked entry. - @param item reference to the double clicked item (QTreeWidgetItem) - @param column column that was double clicked (integer) + @param item reference to the double clicked item + @type QTreeWidgetItem + @param column column that was double clicked + @type int """ self.on_editButton_clicked()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgCopyDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgCopyDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -27,9 +27,12 @@ """ Constructor - @param source name of the source file/directory (string) - @param parent parent widget (QWidget) - @param move flag indicating a move operation (boolean) + @param source name of the source file/directory + @type str + @param parent parent widget + @type QWidget + @param move flag indicating a move operation + @type bool """ super().__init__(parent) self.setupUi(self) @@ -57,7 +60,8 @@ Public method to retrieve the copy data. @return the target name (string) and a flag indicating - the operation should be enforced (boolean) + the operation should be enforced + @rtype bool """ target = self.targetPicker.text() if not os.path.isabs(target): @@ -70,7 +74,8 @@ """ Private slot to handle changes of the target. - @param txt contents of the target edit (string) + @param txt contents of the target edit + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( os.path.isabs(txt) or os.path.dirname(txt) == ""
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -28,11 +28,15 @@ """ Constructor - @param text text to be shown by the label (string) - @param hg reference to the Mercurial interface object (Hg) + @param text text to be shown by the label + @type str + @param hg reference to the Mercurial interface object + @type Hg @param useClient flag indicating to use the command server client - if possible (boolean) - @param parent parent widget (QWidget) + if possible + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -73,7 +77,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -147,7 +152,8 @@ """ Public method to check for a normal process termination. - @return flag indicating normal process termination (boolean) + @return flag indicating normal process termination + @rtype bool """ return self.normal @@ -156,7 +162,8 @@ Public method to check for a normal process termination without error messages. - @return flag indicating normal process termination (boolean) + @return flag indicating normal process termination + @rtype bool """ return self.normal and self.errors.toPlainText() == "" @@ -164,7 +171,8 @@ """ Private slot to show some output. - @param out output to be shown (string) + @param out output to be shown + @type str """ self.resultbox.insertPlainText(Utilities.filterAnsiSequences(out)) self.resultbox.ensureCursorVisible() @@ -182,7 +190,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(Utilities.filterAnsiSequences(out)) @@ -194,7 +203,8 @@ """ Public method to check, if the last action contained an add or delete. - @return flag indicating the presence of an add or delete (boolean) + @return flag indicating the presence of an add or delete + @rtype bool """ return self.__hasAddOrDelete
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDiffDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDiffDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -33,7 +33,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Hg + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -62,7 +64,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ self.__diffGenerator.stopProcess() e.accept() @@ -71,12 +74,16 @@ """ Public slot to start the hg diff command. - @param fn filename to be diffed (string) - @param versions list of versions to be diffed (list of up to - 2 strings or None) - @param bundle name of a bundle file (string) - @param qdiff flag indicating qdiff command shall be used (boolean) - @param refreshable flag indicating a refreshable diff (boolean) + @param fn filename to be diffed + @type str + @param versions list of versions to be diffed or None + @type list of [str, str] + @param bundle name of a bundle file + @type str + @param qdiff flag indicating qdiff command shall be used + @type bool + @param refreshable flag indicating a refreshable diff + @type bool """ self.refreshButton.setVisible(refreshable) @@ -152,7 +159,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Save): self.on_saveButton_clicked() @@ -164,7 +172,8 @@ """ Private slot to handle the selection of a file. - @param index activated row (integer) + @param index activated row + @type int """ para = self.filesCombo.itemData(index)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDiffGenerator.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDiffGenerator.py Sat Dec 23 15:40:23 2023 +0100 @@ -28,7 +28,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Hg + @param parent parent widget + @type QWidget """ super().__init__(parent) @@ -47,8 +49,10 @@ """ Private method to get a hg revision argument for the given revision. - @param version revision (integer or string) - @return version argument (string) + @param version revision + @type int or str + @return version argument + @rtype str """ if version == "WORKING": return None @@ -59,13 +63,16 @@ """ Public slot to start the hg diff command. - @param fn filename to be diffed (string) - @param versions list of versions to be diffed (list of up to - 2 strings or None) - @param bundle name of a bundle file (string) - @param qdiff flag indicating qdiff command shall be used (boolean) + @param fn filename to be diffed + @type str + @param versions list of versions to be diffed + @type list of up to 2 str or None + @param bundle name of a bundle file + @type str + @param qdiff flag indicating qdiff command shall be used + @type bool @return flag indicating a successful start of the diff command - (boolean) + @rtype bool """ if qdiff: args = self.vcs.initCommand("qdiff") @@ -144,9 +151,9 @@ """ Public method to return the result data. - @return tuple of lists of string containing lines of the diff, the - list of errors and a list of tuples of filenames and the line - into the diff output. + @return tuple containing a list of lines of the diff, a list of errors + and a list of tuples of filenames and the line into the diff output + @rtype tuple of (list of str, list of str, list of tuple of (str, int)) """ return (self.__output, self.__errors, self.__fileSeparators) @@ -154,8 +161,10 @@ """ Private method to extract the file name out of a file separator line. - @param line line to be processed (string) - @return extracted file name (string) + @param line line to be processed + @type str + @return extracted file name + @rtype str """ f = line.split(None, 1)[1] f = f.rsplit(None, 6)[0]
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDiffHighlighter.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDiffHighlighter.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,7 +22,8 @@ """ Constructor - @param doc reference to the text document (QTextDocument) + @param doc reference to the text document + @type QTextDocument """ super().__init__(doc)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExportDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExportDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -72,7 +72,8 @@ """ Private slot to react on changes of the export directory edit. - @param txt contents of the line edit (string) + @param txt contents of the line edit + @type str """ self.__updateOK() @@ -81,7 +82,8 @@ """ Private slot to react on changes of the export file name pattern edit. - @param txt contents of the line edit (string) + @param txt contents of the line edit + @type str """ self.__updateOK()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExtension.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExtension.py Sat Dec 23 15:40:23 2023 +0100 @@ -20,6 +20,7 @@ Constructor @param vcs reference to the Mercurial vcs object + @type Hg """ super().__init__(vcs)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectBrowserHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectBrowserHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,8 +26,11 @@ Constructor @param vcsObject reference to the vcs object + @type Hg @param browserObject reference to the project browser object + @type ProjectBaseBrowser @param projectObject reference to the project object + @type Project """ super().__init__() @@ -41,9 +44,9 @@ Note: Derived class must implement this method. - @return dictionary of populated menu (dict of QMenu). The dict - must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' - and 'dirMultiMenu'. + @return dictionary of populated menu. The dict must have the keys + 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. + @rtype dict of QMenu @exception NotImplementedError raised if the class has not been reimplemented """ @@ -63,7 +66,8 @@ Note: Derived class must implement this method. - @return title of the menu (string) + @return title of the menu + @rtype str @exception NotImplementedError raised if the class has not been reimplemented """ @@ -78,11 +82,12 @@ Note: Derived class must implement this method to adjust the enabled states of its menus. - @param key menu key (string, one of 'mainMenu', 'multiMenu', + @param key menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' or 'dirMultiMenu') + @type str @param controlled flag indicating to prepare the menu for a version controlled entry or a non-version controlled entry - (boolean) + @type bool @exception NotImplementedError raised if the class has not been reimplemented """ @@ -92,7 +97,7 @@ """ Protected method to update the VCS status of an item. - @param name filename or directoryname of the item to be updated - (string) + @param name filename or directory name of the item to be updated + @type str """ self.project.getModel().updateVCSStatus(name)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -35,7 +35,9 @@ Public method to set references to the vcs and project objects. @param vcsObject reference to the vcs object + @type Hg @param projectObject reference to the project object + @type Project """ self.vcs = vcsObject self.project = projectObject @@ -44,7 +46,8 @@ """ Public method to get a list of all actions. - @return list of all actions (list of EricAction) + @return list of all actions + @rtype list of EricAction """ return self.actions[:] @@ -65,8 +68,10 @@ Note: Derived class must implement this method. - @param mainMenu reference to the main menu (QMenu) - @return populated menu (QMenu) + @param mainMenu reference to the main menu + @type QMenu + @return populated menu + @rtype QMenu @exception NotImplementedError raised if the class has not been reimplemented """ @@ -80,7 +85,8 @@ Note: Derived class must implement this method. - @return title of the menu (string) + @return title of the menu + @rtype str @exception NotImplementedError raised if the class has not been reimplemented """
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgGraftDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgGraftDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -85,7 +85,8 @@ """ Private slot to handle changes of the user name. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__updateOk()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgImportDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgImportDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -65,7 +65,8 @@ """ Private slot to react on changes of the patch file edit. - @param txt contents of the line edit (string) + @param txt contents of the line edit + @type str """ self.__updateOK()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -542,7 +542,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -660,8 +661,10 @@ """ Private method to calculate a color for a given branch name. - @param branchName name of the branch (string) - @return name of the color to use (string) + @param branchName name of the branch + @type str + @return name of the color to use + @rtype str """ if branchName not in self.__branchColors: self.__branchColors[branchName] = self.__getColor(len(self.__branchColors)) @@ -671,12 +674,14 @@ """ Private method to generate edge info for the give data. - @param rev revision to calculate edge info for (integer) - @param parents list of parent revisions (list of integers) + @param rev revision to calculate edge info for + @type int + @param parents list of parent revisions + @type list of int @return tuple containing the column and color index for the given node and a list of tuples indicating the edges between the given node and its parents - (integer, integer, [(integer, integer, integer), ...]) + @rtype tuple of (int, int, [(int, int, int), ...]) """ if rev not in self.__revs: # new head @@ -752,8 +757,10 @@ """ Local function to calculate a x-position for a column. - @param col column number (integer) - @param radius radius of the indicator circle (integer) + @param col column number + @type int + @param radius radius of the indicator circle + @type int """ return int(1.2 * radius) * col + radius // 2 + 3 @@ -837,8 +844,10 @@ Private method to get the parents of the currently viewed file/directory. - @param rev revision number to get parents for (string) - @return list of parent revisions (list of integers) + @param rev revision number to get parents for + @type str + @return list of parent revisions + @rtype list of int """ errMsg = "" parents = [-1] @@ -1088,8 +1097,10 @@ """ Private method to retrieve log entries from the repository. - @param startRev revision number to start from (integer, string) - @param noEntries number of entries to get (0 = default) (int) + @param startRev revision number to start from + @type int or str + @param noEntries number of entries to get (0 = default) + @type int """ self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setEnabled(False) self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel).setEnabled(True) @@ -1244,8 +1255,10 @@ """ Private method to convert the displayed file name for a large file. - @param filename file name to be processed (string) - @return processed file name (string) + @param filename file name to be processed + @type str + @return processed file name + @rtype str """ if filename.startswith((self.LargefilesCacheL, self.LargefilesCacheW)): return self.tr("{0} (large file)").format( @@ -1466,7 +1479,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out) @@ -1476,7 +1490,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -1870,8 +1885,10 @@ """ Private slot called, when the current item of the log tree changes. - @param current reference to the new current item (QTreeWidgetItem) - @param previous reference to the old current item (QTreeWidgetItem) + @param current reference to the new current item + @type QTreeWidgetItem + @param previous reference to the old current item + @type QTreeWidgetItem """ self.__updateToolMenuActions() @@ -1943,7 +1960,8 @@ """ Private slot called, when the from date changes. - @param date new date (QDate) + @param date new date + @type QDate """ if self.__actionMode() == "filter": self.__filterLogs() @@ -1953,7 +1971,8 @@ """ Private slot called, when the from date changes. - @param date new date (QDate) + @param date new date + @type QDate """ if self.__actionMode() == "filter": self.__filterLogs() @@ -1985,7 +2004,8 @@ """ Private slot called, when a filter expression is entered. - @param txt filter expression (string) + @param txt filter expression + @type str """ if self.__actionMode() == "filter": self.__filterLogs() @@ -2053,7 +2073,8 @@ Private slot to prepare the filed search data. @return tuple of field index, search expression and flag indicating - that the field index is a data role (integer, string, boolean) + that the field index is a data role + @rtype tuple of (int, str, bool) """ indexIsRole = False txt = self.fieldCombo.itemData(self.fieldCombo.currentIndex()) @@ -2086,7 +2107,8 @@ """ Private slot called, when the stop on copy/move checkbox is clicked. - @param checked flag indicating the state of the check box (boolean) + @param checked flag indicating the state of the check box + @type bool """ self.vcs.getPlugin().setPreferences( "StopLogOnCopy", self.stopCheckBox.isChecked() @@ -2592,7 +2614,8 @@ """ Private method to get the selected action mode. - @return selected action mode (string, one of filter or find) + @return selected action mode (one of 'filter' or 'find') + @rtype str """ return self.modeComboBox.itemData(self.modeComboBox.currentIndex()) @@ -2601,7 +2624,8 @@ """ Private slot to react on mode changes. - @param index index of the selected entry (integer) + @param index index of the selected entry + @type int """ mode = self.modeComboBox.itemData(index) findMode = mode == "find" @@ -2638,8 +2662,10 @@ """ Private slot to find an item matching the entered criteria. - @param backwards flag indicating to search backwards (boolean) - @param interactive flag indicating an interactive search (boolean) + @param backwards flag indicating to search backwards + @type bool + @param interactive flag indicating an interactive search + @type bool """ self.__findBackwards = backwards @@ -2810,8 +2836,10 @@ """ Private slot called, when the current item of the files tree changes. - @param current reference to the new current item (QTreeWidgetItem) - @param previous reference to the old current item (QTreeWidgetItem) + @param current reference to the new current item + @type QTreeWidgetItem + @param previous reference to the old current item + @type QTreeWidgetItem """ if current: para = current.data(0, self.__diffFileLineRole)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgNewProjectOptionsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgNewProjectOptionsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -31,7 +31,9 @@ Constructor @param vcs reference to the version control object - @param parent parent widget (QWidget) + @type Hg + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -70,7 +72,8 @@ """ Private slot to handle a change of the project directory. - @param txt name of the project directory (string) + @param txt name of the project directory + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( bool(txt) @@ -82,7 +85,8 @@ """ Private slot to handle changes of the URL. - @param txt current text of the line edit (string) + @param txt current text of the line edit + @type str """ url = QUrl.fromUserInput(txt) enable = url.isValid() and url.scheme() in ConfigHgSchemes @@ -106,8 +110,9 @@ Public slot to retrieve the data entered into the dialog and to save the history of entered repository URLs. - @return a tuple of a string (project directory) and a dictionary - containing the data entered. + @return tuple containing the project directory and a dictionary + containing the data entered + @rtype tuple of (str, dict) """ self.__saveHistory()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgOptionsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgOptionsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -24,8 +24,11 @@ Constructor @param vcs reference to the version control object + @type Hg @param project reference to the project object - @param parent parent widget (QWidget) + @type Project + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -38,6 +41,7 @@ Public slot to retrieve the data entered into the dialog. @return a dictionary containing the data entered + @rtype dict """ vcsdatadict = { "message": self.vcsLogEdit.text(),
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgPhaseDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgPhaseDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,7 +23,8 @@ """ Constructor - @param parent reference to the parent widget (QWidget) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -66,7 +67,8 @@ Public method to retrieve the entered data. @return tuple with list of revisions, phase and a flag indicating - a forced operation (list of strings, string, boolean) + a forced operation + @rtype tuple of (list of str, str, bool) """ return ( self.revisionsEdit.toPlainText().strip().splitlines(),
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgRemoveSubrepositoriesDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgRemoveSubrepositoriesDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,8 +22,10 @@ """ Constructor - @param subrepositories list of sub-repository entries (list of strings) - @param parent reference to the parent widget (QWidget) + @param subrepositories list of sub-repository entries + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -54,8 +56,8 @@ Public method to retrieve the data. @return tuple giving the remaining sub-repositories, the removed ones - and a flag indicating to delete the removed ones from disc (list - of strings, list of strings, boolean) + and a flag indicating to delete the removed ones from disc + @rtype tuple of (list of str, list of str, bool) """ return ( [
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgRepoConfigDataDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgRepoConfigDataDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -27,11 +27,12 @@ """ Constructor - @param withLargefiles flag indicating to configure the largefiles - section (boolean) - @param largefilesData dictionary with data for the largefiles - section (dict) - @param parent reference to the parent widget (QWidget) + @param withLargefiles flag indicating to configure the largefiles section + @type bool + @param largefilesData dictionary with data for the largefiles section + @type dictdict + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -58,7 +59,8 @@ Private slot to switch the default password visibility of the default password. - @param checked state of the push button (boolean) + @param checked state of the push button + @type bool """ if checked: self.defaultPasswordEdit.setEchoMode(QLineEdit.EchoMode.Normal) @@ -71,7 +73,8 @@ Private slot to switch the default password visibility of the default push password. - @param checked state of the push button (boolean) + @param checked state of the push button + @type bool """ if checked: self.defaultPushPasswordEdit.setEchoMode(QLineEdit.EchoMode.Normal) @@ -82,8 +85,8 @@ """ Public method to get the data entered into the dialog. - @return tuple giving the default and default push URLs (tuple of - two strings) + @return tuple giving the default and default push URLs + @rtype tuple of (str, str) """ defaultUrl = QUrl.fromUserInput(self.defaultUrlEdit.text()) username = self.defaultUserEdit.text() @@ -109,8 +112,9 @@ """ Public method to get the data for the largefiles extension. - @return tuple with the minimum file size (integer) and file patterns - (list of string). None as value denote to use the default value. + @return tuple with the minimum file size and file patterns. None as value + denote to use the default value. + @rtype tuple of (int, list of str) """ if self.__withLargefiles: lfDefaults = getLargefilesDefaults()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgStatusDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgStatusDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -41,8 +41,11 @@ Constructor @param vcs reference to the vcs object - @param mq flag indicating to show a queue repo status (boolean) - @param parent parent widget (QWidget) + @type Hg + @param mq flag indicating to show a queue repo status + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -220,7 +223,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -286,8 +290,10 @@ """ Private method to generate a status item in the status list. - @param status status indicator (string) - @param path path of the file or directory (string) + @param status status indicator + @type str + @param path path of the file or directory + @type str """ statusText = self.status[status] itm = QTreeWidgetItem( @@ -316,7 +322,7 @@ Public slot to start the hg status command. @param fn filename(s)/directoryname(s) to show the status of - (string or list of strings) + @type str or list of str """ self.errorGroup.hide() self.intercept = False @@ -389,7 +395,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -402,7 +409,8 @@ """ Private method to process the lines of output. - @param line output line to be processed (string) + @param line output line to be processed + @type str """ if line[0] in "ACIMR?!" and line[1] == " ": status, path = line.strip().split(" ", 1) @@ -412,7 +420,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out) @@ -581,7 +590,8 @@ """ Private slot to add a file to the repository. - @param mode add mode (string one of 'normal' or 'large') + @param mode add mode (one of 'normal' or 'large') + @type str """ names = [ os.path.join(self.__repoPath, itm.text(self.__pathColumn)) @@ -724,6 +734,7 @@ Private method to retrieve all entries the user wants to commit. @return list of all items, the user has checked + @rtype list of QTreeWidgetItems """ commitableItems = [] for index in range(self.statusList.topLevelItemCount()): @@ -738,6 +749,7 @@ selected. @return list of all items, the user has checked + @rtype list of QTreeWidgetItems """ items = [] for index in range(self.statusList.topLevelItemCount()): @@ -754,6 +766,7 @@ Private method to retrieve all entries, that have a modified status. @return list of all items with a modified status + @rtype list of QTreeWidgetItems """ modifiedItems = [] for itm in self.statusList.selectedItems(): @@ -767,6 +780,7 @@ status. @return list of all items with an unversioned status + @rtype list of QTreeWidgetItems """ unversionedItems = [] for itm in self.statusList.selectedItems(): @@ -779,6 +793,7 @@ Private method to retrieve all entries, that have a missing status. @return list of all items with a missing status + @rtype list of QTreeWidgetItems """ missingItems = [] for itm in self.statusList.selectedItems(): @@ -790,7 +805,8 @@ """ Private slot to select or deselect all entries. - @param selected commit selection state to be set (boolean) + @param selected commit selection state to be set + @type bool """ for index in range(self.statusList.topLevelItemCount()): itm = self.statusList.topLevelItem(index)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgStatusMonitorThread.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgStatusMonitorThread.py Sat Dec 23 15:40:23 2023 +0100 @@ -19,10 +19,14 @@ """ Constructor - @param interval new interval in seconds (integer) - @param project reference to the project object (Project) + @param interval new interval in seconds + @type int + @param project reference to the project object + @type Project @param vcs reference to the version control object - @param parent reference to the parent object (QObject) + @type Hg + @param parent reference to the parent object + @type QObject """ VcsStatusMonitorThread.__init__(self, interval, project, vcs, parent)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgSummaryDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgSummaryDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -25,7 +25,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Hg + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -43,9 +45,11 @@ """ Public slot to start the hg summary command. - @param mq flag indicating to show the queue status as well (boolean) + @param mq flag indicating to show the queue status as well + @type bool @param largefiles flag indicating to show the largefiles status as - well (boolean) + well + @type bool """ self.errorGroup.hide() self.refreshButton.setEnabled(False) @@ -75,7 +79,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -100,7 +105,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out) @@ -110,7 +116,8 @@ """ Private method to process the output into nice readable text. - @param output output from the summary command (string) + @param output output from the summary command + @type str """ infoDict = {}
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgTagBranchListDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgTagBranchListDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -35,7 +35,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Hg + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -67,7 +69,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -80,9 +83,11 @@ @param tags flag indicating a list of tags is requested (False = branches, True = tags) + @type bool @param tagsList reference to string list receiving the tags - (list of strings) - @param allTagsList reference to string list all tags (list of strings) + @type list of str + @param allTagsList reference to string list all tags + @type list of str """ self.errorGroup.hide() self.tagList.clear() @@ -151,7 +156,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -179,10 +185,14 @@ """ Private method to generate a tag item in the tag list. - @param revision revision of the tag/branch (string) - @param changeset changeset of the tag/branch (string) - @param status of the tag/branch (string) - @param name name of the tag/branch (string) + @param revision revision of the tag/branch + @type str + @param changeset changeset of the tag/branch + @type str + @param status of the tag/branch + @type str + @param name name of the tag/branch + @type str """ itm = QTreeWidgetItem(self.tagList) itm.setData(0, Qt.ItemDataRole.DisplayRole, int(revision)) @@ -197,7 +207,8 @@ """ Private method to process the lines of output. - @param line output line to be processed (string) + @param line output line to be processed + @type str """ li = line.split() if li[-1][0] in "1234567890": @@ -227,7 +238,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgTagDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgTagDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -29,10 +29,14 @@ """ Constructor - @param taglist list of previously entered tags (list of strings) - @param revision revision to set tag for (string) - @param tagName name of the tag (string) - @param parent parent widget (QWidget) + @param taglist list of previously entered tags + @type list of str + @param revision revision to set tag for + @type str + @param tagName name of the tag + @type str + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -70,7 +74,8 @@ """ Private method used to enable/disable the OK-button. - @param text tag name entered in the combo (string) + @param text tag name entered in the combo + @type str """ self.okButton.setDisabled(text == "") @@ -79,7 +84,8 @@ """ Private slot setting the local status of the selected entry. - @param index index of the selected entrie (integer) + @param index index of the selected entrie + @type int """ isLocal = self.tagCombo.itemData(index) if isLocal:
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HisteditExtension/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -115,7 +115,8 @@ @param mainMenu reference to the main menu @type QMenu - @return populated menu (QMenu) + @return populated menu + @rtype QMenu """ menu = QMenu(self.menuTitle(), mainMenu) menu.setIcon(EricPixmapCache.getIcon("vcsEditHistory"))
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/LfConvertDataDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/LfConvertDataDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -28,9 +28,12 @@ """ Constructor - @param currentPath directory name of the current project (string) - @param mode dialog mode (string, one of 'largefiles' or 'normal') - @param parent reference to the parent widget (QWidget) + @param currentPath directory name of the current project + @type str + @param mode dialog mode (one of 'largefiles' or 'normal') + @type str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -58,7 +61,8 @@ """ Private slot to handle editing of the new project directory. - @param txt new project directory name (string) + @param txt new project directory name + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( txt @@ -70,8 +74,9 @@ """ Public method to retrieve the entered data. - @return tuple containing the new project directory name (string), - minimum file size (integer) and file patterns (list of string) + @return tuple containing the new project directory name, minimum file size + and file patterns + @rtype tuple of (str, int, list of str) """ patterns = self.lfFilePatternsEdit.text().split() if set(patterns) == set(self.__defaults["pattern"]):
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/LfRevisionsInputDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/LfRevisionsInputDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,7 +22,8 @@ """ Constructor - @param parent reference to the parent widget (QWidget) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -42,6 +43,7 @@ """ Public method to retrieve the entered revisions. - @return list of revisions (list of string) + @return list of revisions + @rtype list of str """ return self.revisionsEdit.toPlainText().splitlines()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/ProjectBrowserHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/ProjectBrowserHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -24,8 +24,11 @@ Constructor @param vcsObject reference to the vcs object + @type Hg @param browserObject reference to the project browser object + @type ProjectBaseBrowser @param projectObject reference to the project object + @type Project """ super().__init__(vcsObject, browserObject, projectObject) @@ -35,9 +38,9 @@ Note: Derived class must implement this method. - @return dictionary of populated menu (dict of QMenu). The dict - must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' - and 'dirMultiMenu'. + @return dictionary of populated menu. The dict must have the keys + 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. + @rtype dict of QMenu """ self.__menus = {} self.__addSingleActs = [] @@ -83,7 +86,8 @@ Note: Derived class must implement this method. - @return title of the menu (string) + @return title of the menu + @rtype str """ return self.tr("Large Files") @@ -91,11 +95,12 @@ """ Public method to prepare the extension menu for display. - @param key menu key (string, one of 'mainMenu', 'multiMenu', - 'backMenu', 'dirMenu' or 'dirMultiMenu') + @param key menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' + or 'dirMultiMenu') + @type str @param controlled flag indicating to prepare the menu for a version controlled entry or a non-version controlled entry - (boolean) + @type bool """ if key == "mainMenu": for act in self.__addSingleActs: @@ -108,7 +113,8 @@ """ Private slot to add the selected files as large files. - @param mode add mode (string one of 'normal' or 'large') + @param mode add mode (string ne of 'normal' or 'large') + @type str """ names = [] for itm in self.browser.getSelectedItems():
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -188,8 +188,10 @@ """ Public method to generate the extension menu. - @param mainMenu reference to the main menu (QMenu) - @return populated menu (QMenu) + @param mainMenu reference to the main menu + @type QMenu + @return populated menu + @rtype QMenu """ menu = QMenu(self.menuTitle(), mainMenu) menu.setTearOffEnabled(True) @@ -215,7 +217,8 @@ """ Public method to get the menu title. - @return title of the menu (string) + @return title of the menu + @rtype str """ return self.tr("Large Files") @@ -232,8 +235,8 @@ """ Private slot to convert the repository format of the current project. - @param direction direction of the conversion (string; one of - 'largefiles' or 'normal') + @param direction direction of the conversion (one of 'largefiles' or 'normal') + @type str @exception ValueError raised to indicate a bad value for the 'direction' parameter. """ @@ -260,9 +263,9 @@ """ Private slot to verify large files integrity. - @param mode verify mode (string; one of 'large', 'lfa' or 'lfc') - @exception ValueError raised to indicate a bad value for the - 'mode' parameter. + @param mode verify mode (one of 'large', 'lfa' or 'lfc') + @type str + @exception ValueError raised to indicate a bad value for the 'mode' parameter. """ if mode not in ["large", "lfa", "lfc"]: raise ValueError("Bad value for 'mode' parameter.")
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/__init__.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/__init__.py Sat Dec 23 15:40:23 2023 +0100 @@ -12,7 +12,8 @@ """ Function to get the default values of the extension. - @return dictionary with default values and parameter as key (dict) + @return dictionary with default values and parameter as key + @rtype dict """ return { "minsize": 10, # minimum size in MB
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/largefiles.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/LargefilesExtension/largefiles.py Sat Dec 23 15:40:23 2023 +0100 @@ -30,6 +30,7 @@ Constructor @param vcs reference to the Mercurial vcs object + @type Hg """ super().__init__(vcs) @@ -37,9 +38,10 @@ """ Public slot to convert the repository format of the current project. - @param direction direction of the conversion (string, one of - 'largefiles' or 'normal') - @param projectFile file name of the current project file (string) + @param direction direction of the conversion (one of 'largefiles' or 'normal') + @type str + @param projectFile file name of the current project file + @type str @exception ValueError raised to indicate a bad value for the 'direction' parameter. """ @@ -123,8 +125,10 @@ """ Public method used to add a file to the Mercurial repository. - @param names file name(s) to be added (string or list of string) - @param mode add mode (string one of 'normal' or 'large') + @param names file name(s) to be added + @type str or list of str + @param mode add mode (one of 'normal' or 'large') + @type str """ args = self.vcs.initCommand("add") args.append("-v") @@ -147,7 +151,8 @@ """ Public method to pull missing large files into the local repository. - @param revisions list of revisions to pull (list of string) + @param revisions list of revisions to pull + @type list of str """ from .LfRevisionsInputDialog import LfRevisionsInputDialog @@ -175,7 +180,8 @@ """ Public method to verify large files integrity. - @param mode verify mode (string; one of 'large', 'lfa' or 'lfc') + @param mode verify mode (one of 'large', 'lfa' or 'lfc') + @type str """ args = self.vcs.initCommand("verify") if mode == "large":
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ProjectBrowserHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ProjectBrowserHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -36,12 +36,18 @@ Constructor @param vcsObject reference to the vcs object + @type Hg @param browserObject reference to the project browser object + @type ProjectBaseBrowser @param projectObject reference to the project object + @type Project @param isTranslationsBrowser flag indicating, the helper is requested for the translations browser (this needs some special treatment) - @param parent parent widget (QWidget) - @param name name of this object (string) + @type bool + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ from .LargefilesExtension.ProjectBrowserHelper import ( LargefilesProjectBrowserHelper, @@ -80,11 +86,12 @@ """ Private slot showing the extensions menu. - @param key menu key (string, one of 'mainMenu', 'multiMenu', - 'backMenu', 'dirMenu' or 'dirMultiMenu') + @param key menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' + or 'dirMultiMenu') + @type str @param controlled flag indicating to show the menu for a version controlled entry or a non-version controlled entry - (boolean) + @type bool """ for extensionName in self.__extensionMenus: if key in self.__extensionMenus[extensionName]: @@ -108,8 +115,10 @@ VCS status and the file status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ if self.browser.currentItem().data(1) == self.vcs.vcsName(): controlled = True @@ -143,8 +152,10 @@ VCS status and the files status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ vcsName = self.vcs.vcsName() items = self.browser.getSelectedItems() @@ -184,8 +195,10 @@ VCS status and the directory status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ if self.browser.currentItem().data(1) == self.vcs.vcsName(): controlled = True @@ -213,8 +226,10 @@ VCS status and the directory status. @param menu reference to the menu to be shown - @param standardItems array of standard items that need + @type QMenu + @param standardItems list of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ vcsName = self.vcs.vcsName() items = self.browser.getSelectedItems() @@ -254,10 +269,13 @@ """ Private method to add an extension menu entry. - @param menu menu to add it to (QMenu) - @param key menu key (string, one of 'mainMenu', 'multiMenu', - 'backMenu', 'dirMenu' or 'dirMultiMenu') - @return reference to the menu action (QAction) + @param menu menu to add it to + @type QMenu + @param key menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' + or 'dirMultiMenu') + @type str + @return reference to the menu action + @rtype QAction """ act = None if key in ["mainMenu", "multiMenu", "backMenu", "dirMenu", "dirMultiMenu"]: @@ -282,6 +300,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ self.vcsMenuActions = [] self.vcsAddMenuActions = [] @@ -424,6 +443,7 @@ project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ self.vcsMultiMenuActions = [] self.vcsAddMultiMenuActions = [] @@ -528,6 +548,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return @@ -572,6 +593,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return @@ -685,6 +707,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -29,9 +29,13 @@ Constructor @param vcsObject reference to the vcs object + @type Hg @param projectObject reference to the project object - @param parent parent widget (QWidget) - @param name name of this object (string) + @type Project + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ from .CloseheadExtension.ProjectHelper import CloseheadProjectHelper from .GpgExtension.ProjectHelper import GpgProjectHelper @@ -71,7 +75,9 @@ Public method to set references to the vcs and project objects. @param vcsObject reference to the vcs object + @type Hg @param projectObject reference to the project object + @type Project """ self.vcs = vcsObject self.project = projectObject @@ -95,7 +101,8 @@ """ Public method to get a reference to the project object. - @return reference to the project object (Project) + @return reference to the project object + @rtype Project """ return self.project @@ -103,7 +110,8 @@ """ Public method to get a list of all actions. - @return list of all actions (list of EricAction) + @return list of all actions + @rtype list of EricAction """ actions = self.actions[:] for extension in self.__extensions.values(): @@ -1681,7 +1689,8 @@ """ Public method to generate the VCS menu. - @param menu reference to the menu to be populated (QMenu) + @param menu reference to the menu to be populated + @type QMenu """ menu.clear() @@ -1882,9 +1891,10 @@ """ Public slot to initialize the VCS toolbar. - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ self.__toolbarManager = toolbarManager @@ -1953,9 +1963,10 @@ """ Public method to remove a toolbar created by initToolbar(). - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ ui.removeToolBar(self.__toolbar) ui.unregisterToolbar("mercurial")
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/PurgeExtension/HgPurgeListDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/PurgeExtension/HgPurgeListDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,8 +22,10 @@ """ Constructor - @param entries list of entries to be shown (list of strings) - @param parent reference to the parent widget (QWidget) + @param entries list of entries to be shown + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/PurgeExtension/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/PurgeExtension/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -136,8 +136,10 @@ """ Public method to generate the extension menu. - @param mainMenu reference to the main menu (QMenu) - @return populated menu (QMenu) + @param mainMenu reference to the main menu + @type QMenu + @return populated menu + @rtype QMenu """ menu = QMenu(self.menuTitle(), mainMenu) menu.setIcon(EricPixmapCache.getIcon("fileDelete")) @@ -155,7 +157,8 @@ """ Public method to get the menu title. - @return title of the menu (string) + @return title of the menu + @rtype str """ return self.tr("Purge")
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/PurgeExtension/purge.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/PurgeExtension/purge.py Sat Dec 23 15:40:23 2023 +0100 @@ -25,6 +25,7 @@ Constructor @param vcs reference to the Mercurial vcs object + @type Hg """ super().__init__(vcs) @@ -98,7 +99,8 @@ Public method to list files and directories not tracked by Mercurial. @param deleteAll flag indicating to list all files including ignored - ones (boolean) + ones + @type bool """ from .HgPurgeListDialog import HgPurgeListDialog
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesDefineGuardsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesDefineGuardsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,9 +26,13 @@ Constructor @param vcs reference to the vcs object - @param extension reference to the extension module (Queues) - @param patchesList list of patches (list of strings) - @param parent reference to the parent widget (QWidget) + @type Hg + @param extension reference to the extension module + @type Queues + @param patchesList list of patches + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -54,7 +58,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -154,8 +159,10 @@ """ Private method to get a reference to a named guard. - @param guard name of the guard (string) - @return reference to the guard item (QListWidgetItem) + @param guard name of the guard + @type str + @return reference to the guard item + @rtype QListWidgetItem """ items = self.guardsList.findItems(guard, Qt.MatchFlag.MatchCaseSensitive) if items: @@ -168,7 +175,8 @@ """ Private slot to handle changes of the text of the guard combo. - @param txt contents of the guard combo line edit (string) + @param txt contents of the guard combo line edit + @type str """ self.addButton.setEnabled(txt != "") @@ -221,7 +229,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Apply): self.__applyGuards()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesFoldDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesFoldDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -25,8 +25,10 @@ """ Constructor - @param patchesList list of patches to select from (list of strings) - @param parent reference to the parent widget (QWidget) + @param patchesList list of patches to select from + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -119,9 +121,10 @@ """ Private slot to react on changes of the current item of source patches. - @param current reference to the new current item (QTreeWidgetItem) + @param current reference to the new current item + @type QTreeWidgetItem @param previous reference to the previous current item - (QTreeWidgetItem) + @type QTreeWidgetItem """ self.addButton.setEnabled(current is not None) @@ -131,9 +134,10 @@ Private slot to react on changes of the current item of selected patches. - @param current reference to the new current item (QTreeWidgetItem) + @param current reference to the new current item + @type QTreeWidgetItem @param previous reference to the previous current item - (QTreeWidgetItem) + @type QTreeWidgetItem """ self.removeButton.setEnabled(current is not None) @@ -146,7 +150,7 @@ Public method to retrieve the entered data. @return tuple of commit message and list of selected patches - (string, list of strings) + @rtype tuple of (str, list of str) """ patchesList = [] for row in range(self.selectedPatches.topLevelItemCount()):
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesGuardsSelectionDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesGuardsSelectionDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,10 +26,14 @@ """ Constructor - @param guards list of guards to select from (list of strings) - @param activeGuards list of active guards (list of strings) - @param listOnly flag indicating to only list the guards (boolean) - @param parent reference to the parent widget (QWidget) + @param guards list of guards to select from + @type list of str + @param activeGuards list of active guards + @type list of str + @param listOnly flag indicating to only list the guards + @type bool + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -53,7 +57,8 @@ """ Public method to retrieve the data. - @return list of selected guards (list of strings) + @return list of selected guards + @rtype list of str """ guardsList = []
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesHeaderDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesHeaderDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,7 +26,9 @@ Constructor @param vcs reference to the vcs object - @param parent reference to the parent widget (QWidget) + @type Hg + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -44,7 +46,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -84,7 +87,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -98,7 +102,8 @@ """ Private slot to show some output. - @param out output to be shown (string) + @param out output to be shown + @type str """ self.messageEdit.appendPlainText(Utilities.filterAnsiSequences(out)) @@ -106,7 +111,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.messageEdit.appendPlainText(self.tr("Error: ")) self.messageEdit.appendPlainText(Utilities.filterAnsiSequences(out))
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesListAllGuardsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesListAllGuardsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -25,7 +25,9 @@ Constructor @param vcs reference to the VCS object (Hg) - @param parent reference to the parent widget (QWidget) + @type Hg + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesListDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesListDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -24,7 +24,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Hg + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -52,7 +54,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -74,7 +77,8 @@ and patches missing in the series file. @param missing flag indicating to get the patches missing in the - series file (boolean) + series file + @type bool """ if missing: self.__mode = "missing" @@ -143,7 +147,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -173,11 +178,16 @@ """ Private method to generate a patch item in the list of patches. - @param index index of the patch (integer, -1 for missing) - @param status status of the patch (string) - @param name name of the patch (string) - @param summary first line of the patch header (string) - @param error flag indicating an error entry (boolean) + @param index index of the patch (-1 for missing) + @type int + @param status status of the patch + @type str + @param name name of the patch + @type str + @param summary first line of the patch header + @type str + @param error flag indicating an error entry + @type bool """ if error: itm = QTreeWidgetItem(self.patchesList, ["", name, "", summary]) @@ -209,7 +219,8 @@ """ Private slot to mark the top patch entry. - @param name name of the patch (string) + @param name name of the patch + @type str """ items = self.patchesList.findItems(name, Qt.MatchFlag.MatchCaseSensitive, 1) if items: @@ -223,7 +234,8 @@ """ Private method to process the lines of output. - @param line output line to be processed (string) + @param line output line to be processed + @type str """ if self.__mode == "qtop": self.__markTopItem(line) @@ -247,7 +259,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesListGuardsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesListGuardsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -25,8 +25,11 @@ Constructor @param vcs reference to the vcs object - @param patchesList list of patches (list of strings) - @param parent reference to the parent widget (QWidget) + @type Hg + @param patchesList list of patches + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -44,7 +47,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel()
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesNewPatchDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesNewPatchDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -29,8 +29,11 @@ @param mode mode of the dialog (HgQueuesNewPatchDialog.NEW_MODE, HgQueuesNewPatchDialog.REFRESH_MODE) - @param message text to set as the commit message (string) - @param parent reference to the parent widget (QWidget) + @type int + @param message text to set as the commit message + @type str + @param parent reference to the parent widget + @type QWidget @exception ValueError raised to indicate an invalid dialog mode """ super().__init__(parent) @@ -79,7 +82,8 @@ """ Private slot to handle changes of the patch name. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__updateUI() @@ -95,7 +99,8 @@ """ Private slot to handle changes of the user group state. - @param checked flag giving the checked state (boolean) + @param checked flag giving the checked state + @type bool """ self.__updateUI() @@ -104,7 +109,8 @@ """ Private slot to handle changes of the currentuser state. - @param checked flag giving the checked state (boolean) + @param checked flag giving the checked state + @type bool """ self.__updateUI() @@ -113,7 +119,8 @@ """ Private slot to handle changes of the user name. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__updateUI() @@ -125,8 +132,9 @@ flag indicating to set the user, a flag indicating to use the current user and the user name and another tuple giving a flag indicating to set the date, a flag indicating to use the - current date and the date (string, string, (boolean, boolean, - string), (boolean, boolean, string)) + current date and the date + @rtype tuple of (str, str, tuple of (bool, bool, str), tuple of + (bool, bool, str)) """ userData = ( self.userGroup.isChecked(),
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesQueueManagementDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesQueueManagementDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -35,11 +35,16 @@ @param mode mode of the dialog (HgQueuesQueueManagementDialog.NO_INPUT HgQueuesQueueManagementDialog.NAME_INPUT, HgQueuesQueueManagementDialog.QUEUE_INPUT) - @param title title for the dialog (string) + @type int + @param title title for the dialog + @type str @param suppressActive flag indicating to not show the name of the - active queue (boolean) + active queue + @type bool @param vcs reference to the vcs object - @param parent reference to the parent widget (QWidget) + @type Hg + @param parent reference to the parent widget + @type QWidget @exception ValueError raised to indicate an invalid dialog mode """ super().__init__(parent) @@ -98,8 +103,8 @@ Private method to get a list of all queues and the name of the active queue. - @return tuple with a list of all queues and the name of the active - queue (list of strings, string) + @return tuple with a list of all queues and the name of the active queue + @rtype tuple of (list of str, str) """ queuesList = [] activeQueue = "" @@ -127,7 +132,8 @@ """ Private slot to handle changes of the entered queue name. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ if self.__mode == HgQueuesQueueManagementDialog.NAME_INPUT: self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( @@ -149,7 +155,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.refreshButton: self.refresh() @@ -173,7 +180,8 @@ """ Public slot to get the data. - @return queue name (string) + @return queue name + @rtype str """ name = "" if self.__mode == HgQueuesQueueManagementDialog.NAME_INPUT:
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesRenamePatchDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/HgQueuesRenamePatchDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,9 +22,12 @@ """ Constructor - @param currentPatch name of the current patch (string) - @param patchesList list of patches to select from (list of strings) - @param parent reference to the parent widget (QWidget) + @param currentPatch name of the current patch + @type str + @param patchesList list of patches to select from + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -52,7 +55,8 @@ """ Private slot to handle changes of the new name. - @param txt text of the edit (string) + @param txt text of the edit + @type str """ self.__updateUI() @@ -61,7 +65,8 @@ """ Private slot to handle changes of the selection method. - @param checked state of the check box (boolean) + @param checked state of the check box + @type bool """ self.__updateUI() @@ -79,7 +84,8 @@ """ Public method to retrieve the entered data. - @return tuple of new name and selected patch (string, string) + @return tuple of new name and selected patch + @rtype tuple of (str, str) """ selectedPatch = "" if self.namedButton.isChecked():
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -871,8 +871,10 @@ """ Public method to generate the extension menu. - @param mainMenu reference to the main menu (QMenu) - @return populated menu (QMenu) + @param mainMenu reference to the main menu + @type QMenu + @return populated menu + @rtype QMenu """ menu = QMenu(self.menuTitle(), mainMenu) menu.setTearOffEnabled(True) @@ -959,7 +961,8 @@ """ Public method to get the menu title. - @return title of the menu (string) + @return title of the menu + @rtype str """ return self.tr("Queues") @@ -1002,10 +1005,14 @@ @param operation operation type to be performed (Queues.POP, Queues.PUSH, Queues.GOTO) - @param doAll flag indicating to push/pop all (boolean) + @type int + @param doAll flag indicating to push/pop all + @type bool @param named flag indicating to push/pop until a named patch - is at the top of the stack (boolean) - @param force flag indicating a forceful pop (boolean) + is at the top of the stack + @type bool + @param force flag indicating a forceful pop + @type bool """ shouldReopen = self.vcs.getExtensionObject("mq").hgQueuePushPopPatches( operation=operation, doAll=doAll, named=named, force=force
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/queues.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/queues.py Sat Dec 23 15:40:23 2023 +0100 @@ -37,6 +37,7 @@ Constructor @param vcs reference to the Mercurial vcs object + @type Hg """ super().__init__(vcs) @@ -76,8 +77,11 @@ @param listType type of patches list to get (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST) - @param withSummary flag indicating to get a summary as well (boolean) - @return list of patches (list of string) + @type int + @param withSummary flag indicating to get a summary as well + @type bool + @return list of patches + @rtype list of str @exception ValueError raised to indicate an invalid patch list type """ patchesList = [] @@ -119,7 +123,8 @@ """ Private method to get the name of the current patch. - @return name of the current patch (string) + @return name of the current patch + @rtype str """ currentPatch = "" @@ -134,7 +139,8 @@ """ Private method to get the commit message of the current patch. - @return name of the current patch (string) + @return name of the current patch + @rtype str """ message = "" @@ -149,8 +155,10 @@ """ Public method to get a list of all guards defined. - @param allGuards flag indicating to get all guards (boolean) - @return sorted list of guards (list of strings) + @param allGuards flag indicating to get all guards + @type bool + @return sorted list of guards + @rtype list of str """ guardsList = [] @@ -214,7 +222,8 @@ Public method to refresh the current patch. @param editMessage flag indicating to edit the current - commit message (boolean) + commit message + @type bool """ from .HgQueuesNewPatchDialog import HgQueuesNewPatchDialog @@ -260,7 +269,8 @@ """ Public method to show the contents of the current patch. - @param name file/directory name (string) + @param name file/directory name + @type str """ from ..HgDiffDialog import HgDiffDialog @@ -287,11 +297,16 @@ @param operation operation type to be performed (Queues.POP, Queues.PUSH, Queues.GOTO) - @param doAll flag indicating to push/pop all (boolean) + @type int + @param doAll flag indicating to push/pop all + @type bool @param named flag indicating to push/pop until a named patch - is at the top of the stack (boolean) - @param force flag indicating a forceful pop (boolean) - @return flag indicating that the project should be reread (boolean) + is at the top of the stack + @type bool + @param force flag indicating a forceful pop + @type bool + @return flag indicating that the project should be reread + @rtype bool @exception ValueError raised to indicate an invalid operation """ if operation not in (Queues.POP, Queues.PUSH, Queues.GOTO): @@ -593,7 +608,8 @@ """ Public method to create a new queue or rename the active queue. - @param isCreate flag indicating to create a new queue (boolean) + @param isCreate flag indicating to create a new queue + @type bool """ from .HgQueuesQueueManagementDialog import HgQueuesQueueManagementDialog @@ -638,6 +654,7 @@ @param operation operation to be performed (Queues.QUEUE_DELETE, Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE) + @type int @exception ValueError raised to indicate an invalid operation """ from .HgQueuesQueueManagementDialog import HgQueuesQueueManagementDialog @@ -720,7 +737,8 @@ """ Public method used to view the status of a queue repository. - @param name directory name (string) + @param name directory name + @type str """ from ..HgStatusDialog import HgStatusDialog
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/RebaseExtension/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/RebaseExtension/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -92,8 +92,10 @@ """ Public method to generate the extension menu. - @param mainMenu reference to the main menu (QMenu) - @return populated menu (QMenu) + @param mainMenu reference to the main menu + @type QMenu + @return populated menu + @rtype QMenu """ menu = QMenu(self.menuTitle(), mainMenu) menu.setIcon(EricPixmapCache.getIcon("vcsRebase")) @@ -109,7 +111,8 @@ """ Public method to get the menu title. - @return title of the menu (string) + @return title of the menu + @rtype str """ return self.tr("Rebase")
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/RebaseExtension/rebase.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/RebaseExtension/rebase.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,6 +23,7 @@ Constructor @param vcs reference to the Mercurial vcs object + @type Hg """ super().__init__(vcs) @@ -30,7 +31,8 @@ """ Public method to rebase changesets to a different branch. - @return flag indicating that the project should be reread (boolean) + @return flag indicating that the project should be reread + @rtype bool """ from .HgRebaseDialog import HgRebaseDialog @@ -90,7 +92,8 @@ """ Public method to continue rebasing changesets from another branch. - @return flag indicating that the project should be reread (boolean) + @return flag indicating that the project should be reread + @rtype bool """ args = self.vcs.initCommand("rebase") args.append("--continue") @@ -108,7 +111,8 @@ """ Public method to abort rebasing changesets from another branch. - @return flag indicating that the project should be reread (boolean) + @return flag indicating that the project should be reread + @rtype bool """ args = self.vcs.initCommand("rebase") args.append("--abort")
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/HgShelveBrowserDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/HgShelveBrowserDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -37,7 +37,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Hg + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -77,7 +79,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if self.__hgClient.isExecuting(): self.__hgClient.cancel() @@ -113,15 +116,19 @@ """ Private method to generate the shelve items. - @param name name of the shelve (string) - @param age age of the shelve (string) - @param message shelve message (string) - @param fileStatistics per file change statistics (tuple of - four strings with file name, number of changes, number of - added lines and number of deleted lines) - @param totals overall statistics (tuple of three strings with - number of changed files, number of added lines and number - of deleted lines) + @param name name of the shelve + @type str + @param age age of the shelve + @type str + @param message shelve message + @type str + @param fileStatistics per file change statistics (tuple containing the + file name, the number of changes, the number of added lines and the + number of deleted lines) + @type tuple of (str, str, str, str) + @param totals overall statistics (tuple containing the number of changed files, + the number of added lines and the number of deleted lines) + @type tuple of (str, str, str) """ itm = QTreeWidgetItem(self.shelveList, [name, age, message]) itm.setData(0, self.__fileStatisticsRole, fileStatistics) @@ -237,7 +244,8 @@ """ Private slot to show some error. - @param out error to be shown (string) + @param out error to be shown + @type str """ self.errorGroup.show() self.errors.insertPlainText(out) @@ -248,7 +256,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -263,8 +272,10 @@ """ Private slot called, when the current item of the shelve list changes. - @param current reference to the new current item (QTreeWidgetItem) - @param previous reference to the old current item (QTreeWidgetItem) + @param current reference to the new current item + @type QTreeWidgetItem + @param previous reference to the old current item + @type QTreeWidgetItem """ self.statisticsList.clear() if current: @@ -293,7 +304,8 @@ """ Private slot to show the context menu of the shelve list. - @param pos position of the mouse pointer (QPoint) + @param pos position of the mouse pointer + @type QPoint """ selectedItemsCount = len(self.shelveList.selectedItems()) self.__unshelveAct.setEnabled(selectedItemsCount == 1)
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/HgShelvesSelectionDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/HgShelvesSelectionDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,9 +22,12 @@ """ Constructor - @param message message to be shown (string) - @param shelveNames list of shelve names (list of string) - @param parent reference to the parent widget (QWidget) + @param message message to be shown + @type str + @param shelveNames list of shelve names + @type list of str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -47,7 +50,8 @@ """ Public method to retrieve the selected shelve names. - @return selected shelve names (list of string) + @return selected shelve names + @rtype list of str """ names = [] for itm in self.shelvesList.selectedItems():
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/HgUnshelveDataDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/HgUnshelveDataDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -21,9 +21,12 @@ """ Constructor - @param shelveNames list of available shelves (list of string) - @param shelveName name of the shelve to restore (string) - @param parent reference to the parent widget (QWidget) + @param shelveNames list of available shelves + @type list of str + @param shelveName name of the shelve to restore + @type str + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -41,8 +44,9 @@ """ Public method to get the user data. - @return tuple containing the name (string) and a flag indicating - to keep the shelved change (boolean) + @return tuple containing the name and a flag indicating to keep the + shelved change + @rtype tuple of (str, bool) """ return ( self.nameComboBox.currentText().replace(" ", "_"),
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/ProjectBrowserHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/ProjectBrowserHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -24,8 +24,11 @@ Constructor @param vcsObject reference to the vcs object + @type Hg @param browserObject reference to the project browser object + @type ProjectBaseBrowser @param projectObject reference to the project object + @type Project """ super().__init__(vcsObject, browserObject, projectObject) @@ -33,9 +36,9 @@ """ Public method to generate the extension menus. - @return dictionary of populated menu (dict of QMenu). The dict - must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' - and 'dirMultiMenu'. + @return dictionary of populated menu. The dict must have the keys 'mainMenu', + 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. + @rtype dict of QMenu """ self.__menus = {} @@ -65,7 +68,8 @@ """ Public method to get the menu title. - @return title of the menu (string) + @return title of the menu + @rtype str """ return self.tr("Shelve") @@ -73,11 +77,12 @@ """ Public method to prepare the extension menu for display. - @param key menu key (string, one of 'mainMenu', 'multiMenu', - 'backMenu', 'dirMenu' or 'dirMultiMenu') + @param key menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' + or 'dirMultiMenu') + @type str @param controlled flag indicating to prepare the menu for a version controlled entry or a non-version controlled entry - (boolean) + @type bool """ if key in self.__menus: self.__menus[key].setEnabled(controlled) @@ -87,8 +92,10 @@ Private method to reopen the project if needed and wanted. @param shouldReopen flag indicating that the project should - be reopened (boolean) - @param title title of the message box (string) + be reopened + @type bool + @param title title of the message box + @type str """ if shouldReopen: res = EricMessageBox.yesNo(
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -171,8 +171,10 @@ """ Public method to generate the extension menu. - @param mainMenu reference to the main menu (QMenu) - @return populated menu (QMenu) + @param mainMenu reference to the main menu + @type QMenu + @return populated menu + @rtype QMenu """ menu = QMenu(self.menuTitle(), mainMenu) menu.setTearOffEnabled(True) @@ -194,7 +196,8 @@ """ Public method to get the menu title. - @return title of the menu (string) + @return title of the menu + @rtype str """ return self.tr("Shelve") @@ -203,8 +206,10 @@ Private method to reopen the project if needed and wanted. @param shouldReopen flag indicating that the project should - be reopened (boolean) - @param title title of the message box (string) + be reopened + @type bool + @param title title of the message box + @type str """ if shouldReopen: res = EricMessageBox.yesNo(
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/shelve.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/shelve.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,6 +26,7 @@ Constructor @param vcs reference to the Mercurial vcs object + @type Hg """ super().__init__(vcs) @@ -44,7 +45,8 @@ """ Private method to get the list of shelved changes. - @return list of shelved changes (list of string) + @return list of shelved changes + @rtype list of str """ args = self.vcs.initCommand("shelve") args.append("--list") @@ -64,8 +66,10 @@ Public method to shelve current changes of files or directories. @param name directory or file name (string) or list of directory - or file names (list of string) - @return flag indicating that the project should be reread (boolean) + or file names + @type list of str + @return flag indicating that the project should be reread + @rtype bool """ from .HgShelveDataDialog import HgShelveDataDialog @@ -118,8 +122,10 @@ """ Public method to restore shelved changes to the project directory. - @param shelveName name of the shelve to restore (string) - @return flag indicating that the project should be reread (boolean) + @param shelveName name of the shelve to restore + @type str + @return flag indicating that the project should be reread + @rtype bool """ from .HgUnshelveDataDialog import HgUnshelveDataDialog @@ -147,7 +153,8 @@ """ Public method to abort the ongoing restore operation. - @return flag indicating that the project should be reread (boolean) + @return flag indicating that the project should be reread + @rtype bool """ args = self.vcs.initCommand("unshelve") args.append("--abort") @@ -164,7 +171,8 @@ """ Public method to continue the ongoing restore operation. - @return flag indicating that the project should be reread (boolean) + @return flag indicating that the project should be reread + @rtype bool """ args = self.vcs.initCommand("unshelve") if self.__unshelveKeep: @@ -183,7 +191,8 @@ """ Public method to delete named shelves. - @param shelveNames name of shelves to delete (list of string) + @param shelveNames name of shelves to delete + @type list of str """ from .HgShelvesSelectionDialog import HgShelvesSelectionDialog
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/StripExtension/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/StripExtension/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -58,7 +58,8 @@ @param mainMenu reference to the main menu @type QMenu - @return populated menu (QMenu) + @return populated menu + @rtype QMenu """ menu = QMenu(self.menuTitle(), mainMenu) menu.setIcon(EricPixmapCache.getIcon("fileDelete"))
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/hg.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/hg.py Sat Dec 23 15:40:23 2023 +0100 @@ -49,8 +49,11 @@ Constructor @param plugin reference to the plugin object - @param parent parent widget (QWidget) - @param name name of this object (string) + @type VcsMercurialPlugin + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ from .CloseheadExtension.closehead import Closehead from .GpgExtension.gpg import Gpg @@ -161,7 +164,8 @@ """ Public method to get a reference to the plugin object. - @return reference to the plugin object (VcsMercurialPlugin) + @return reference to the plugin object + @rtype VcsMercurialPlugin """ return self.__plugin @@ -169,7 +173,8 @@ """ Public method to get the encoding to be used by Mercurial. - @return encoding (string) + @return encoding + @rtype str """ return self.__plugin.getPreferences("Encoding") @@ -224,8 +229,10 @@ """ Public method to initialize a command arguments list. - @param command command name (string) - @return list of command options (list of string) + @param command command name + @type str + @return list of command options + @rtype list of str """ args = [command] self.addArguments(args, self.__plugin.getGlobalOptions()) @@ -235,8 +242,8 @@ """ Public method used to test for the presence of the hg executable. - @return flag indicating the existence (boolean) and an error message - (string) + @return flag indicating the existence and an error message + @rtype tuple of (bool, str) """ from .HgUtilities import hgVersion @@ -254,9 +261,12 @@ Mercurial controlled project. Therefore we always return TRUE without doing anything. - @param vcsDir name of the VCS directory (string) - @param noDialog flag indicating quiet operations (boolean) - @return always TRUE + @param vcsDir name of the VCS directory + @type str + @param noDialog flag indicating quiet operations + @type bool + @return always True + @rtype bool """ return True @@ -294,7 +304,7 @@ @param vcsDataDict dictionary of data required for the import @type dict - @param projectDir project directory (string) + @param projectDir project directory @type str @param noDialog flag indicating quiet operations @type bool @@ -343,9 +353,13 @@ (clone). @param vcsDataDict dictionary of data required for the checkout - @param projectDir project directory to create (string) + @type dict + @param projectDir project directory to create + @type str @param noDialog flag indicating quiet operations - @return flag indicating an execution without errors (boolean) + @type bool + @return flag indicating an execution without errors + @rtype bool """ noDialog = False try: @@ -378,8 +392,11 @@ Public method used to export a directory from the Mercurial repository. @param vcsDataDict dictionary of data required for the checkout - @param projectDir project directory to create (string) - @return flag indicating an execution without errors (boolean) + @type dict + @param projectDir project directory to create + @type str + @return flag indicating an execution without errors + @rtype bool """ status = self.vcsCheckout(vcsDataDict, projectDir) shutil.rmtree(os.path.join(projectDir, self.adminDir), ignore_errors=True) @@ -394,13 +411,18 @@ Public method used to make the change of a file/directory permanent in the Mercurial repository. - @param name file/directory name to be committed (string or list of - strings) - @param message message for this operation (string) + @param name file/directory name to be committed + @type str or list of str + @param message message for this operation + @type str @param noDialog flag indicating quiet operations - @param closeBranch flag indicating a close branch commit (boolean) - @param mq flag indicating a queue commit (boolean) - @param merge flag indicating a merge commit (boolean) + @type bool + @param closeBranch flag indicating a close branch commit + @type bool + @param mq flag indicating a queue commit + @type bool + @param merge flag indicating a merge commit + @type bool """ from .HgCommitDialog import HgCommitDialog @@ -606,10 +628,13 @@ repository. @param name file/directory name to be updated (not used) - @param noDialog flag indicating quiet operations (boolean) - @param revision revision to update to (string) - @return flag indicating, that the update contained an add - or delete (boolean) + @type str + @param noDialog flag indicating quiet operations + @type bool + @param revision revision to update to + @type str + @return flag indicating, that the update contained an add or delete + @rtype bool """ args = self.initCommand("update") if "-v" not in args and "--verbose" not in args: @@ -634,9 +659,12 @@ """ Public method used to add a file/directory to the Mercurial repository. - @param name file/directory name to be added (string) - @param isDir flag indicating name is a directory (boolean) + @param name file/directory name to be added + @type str + @param isDir flag indicating name is a directory + @type bool @param noDialog flag indicating quiet operations + @type bool """ args = self.initCommand("add") args.append("-v") @@ -661,8 +689,10 @@ Public method used to add a file/directory in binary mode to the Mercurial repository. - @param name file/directory name to be added (string) - @param isDir flag indicating name is a directory (boolean) + @param name file/directory name to be added + @type str + @param isDir flag indicating name is a directory + @type bool """ self.vcsAdd(name, isDir) @@ -671,8 +701,8 @@ Public method to add a directory tree rooted at path to the Mercurial repository. - @param path root directory of the tree to be added (string or list of - strings)) + @param path root directory of the tree to be added + @type str or list of str """ self.vcsAdd(path, isDir=False) @@ -683,12 +713,14 @@ The default operation is to remove the local copy as well. - @param name file/directory name to be removed (string or list of - strings)) - @param project flag indicating deletion of a project tree (boolean) - (not needed) + @param name file/directory name to be removed + @type str or list of str + @param project flag indicating deletion of a project tree + @type bool @param noDialog flag indicating quiet operations - @return flag indicating successfull operation (boolean) + @type bool + @return flag indicating successfull operation + @rtype bool """ args = self.initCommand("remove") args.append("-v") @@ -719,11 +751,16 @@ """ Public method used to move a file/directory. - @param name file/directory name to be moved (string) + @param name file/directory name to be moved + @type str @param project reference to the project object - @param target new name of the file/directory (string) + @type Project + @param target new name of the file/directory + @type str @param noDialog flag indicating quiet operations - @return flag indicating successfull operation (boolean) + @type bool + @return flag indicating successfull operation + @rtype bool """ from .HgCopyDialog import HgCopyDialog @@ -781,7 +818,8 @@ being edited and has unsaved modification, they can be saved or the operation may be aborted. - @param name file/directory name to be diffed (string) + @param name file/directory name to be diffed + @type str """ from .HgDiffDialog import HgDiffDialog @@ -808,7 +846,7 @@ Mercurial repository. @param name file/directory name(s) to show the status of - (string or list of strings) + @type str or list of str """ from .HgStatusDialog import HgStatusDialog @@ -823,9 +861,11 @@ Public method used to show some summary information of the working directory state. - @param mq flag indicating to show the queue status as well (boolean) + @param mq flag indicating to show the queue status as well + @type bool @param largefiles flag indicating to show the largefiles status as - well (boolean) + well + @type bool """ from .HgSummaryDialog import HgSummaryDialog @@ -840,10 +880,13 @@ Public method used to set/remove a tag in the Mercurial repository. @param name file/directory name to determine the repo root from - (string) - @param revision revision to set tag for (string) - @param tagName name of the tag (string) - @return flag indicating a performed tag action (boolean) + @type str + @param revision revision to set tag for + @type str + @param tagName name of the tag + @type str + @return flag indicating a performed tag action + @rtype bool """ from .HgTagDialog import HgTagDialog @@ -986,7 +1029,8 @@ """ Public method used to merge a URL/revision into the local project. - @param name file/directory name to be merged (string) + @param name file/directory name to be merged + @type str """ from eric7.UI.DeleteFilesConfirmationDialog import DeleteFilesConfirmationDialog @@ -1029,9 +1073,10 @@ Public method used to switch a working directory to a different revision. - @param name directory name to be switched (string) - @return flag indicating, that the switch contained an add - or delete (boolean) + @param name directory name to be switched + @type str + @return flag indicating, that the switch contained an add or delete + @rtype bool """ from .HgRevisionSelectionDialog import HgRevisionSelectionDialog @@ -1053,7 +1098,7 @@ @param name file or directory name to check @type str - @return a combination of canBeCommited and canBeAdded + @return registered state (one of canBeCommited and canBeAdded) @rtype int """ if name.endswith(os.sep): @@ -1094,10 +1139,14 @@ that the states for all files have been populated by the previous run. @param names dictionary with all filenames to be checked as keys - @param dname directory to check in (string) - @param shortcut flag indicating a shortcut should be taken (boolean) + @type dict + @param dname directory to check in + @type str + @param shortcut flag indicating a shortcut should be taken + @type bool @return the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error + @rtype dict """ if dname.endswith(os.sep): dname = dname[:-1] @@ -1155,7 +1204,8 @@ """ Public method returning the name of the vcs. - @return always 'Mercurial' (string) + @return always 'Mercurial' + @rtype str """ return "Mercurial" @@ -1165,7 +1215,8 @@ This method ensures, that an ignore file exists. - @param project reference to the project (Project) + @param project reference to the project + @type Project """ ppath = project.getProjectPath() if ppath: @@ -1177,7 +1228,8 @@ """ Public method used to cleanup the working directory. - @param name directory name to be cleaned up (string) + @param name directory name to be cleaned up + @type str """ patterns = self.getPlugin().getPreferences("CleanupPatterns").split() @@ -1193,7 +1245,8 @@ """ Public method used to execute arbitrary mercurial commands. - @param name directory name of the working directory (string) + @param name directory name of the working directory + @type str """ from .HgCommandDialog import HgCommandDialog @@ -1223,11 +1276,15 @@ Public method to get a dialog to enter repository info. @param project reference to the project object - @param archive name of the project in the repository (string) + @type Project + @param archive name of the project in the repository + @type str @param editable flag indicating that the project name is editable - (boolean) - @param parent parent widget (QWidget) - @return reference to the instantiated options dialog (HgOptionsDialog) + @type bool + @param parent parent widget + @type QWidget + @return reference to the instantiated options dialog + @rtype HgOptionsDialog """ from .HgOptionsDialog import HgOptionsDialog @@ -1238,9 +1295,10 @@ Public method to get a dialog to enter repository info for getting a new project. - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget @return reference to the instantiated options dialog - (HgNewProjectOptionsDialog) + @rtype HgNewProjectOptionsDialog """ from .HgNewProjectOptionsDialog import HgNewProjectOptionsDialog @@ -1250,8 +1308,10 @@ """ Public method to retrieve information about the repository. - @param ppath local path to get the repository infos (string) - @return string with ready formated info for display (string) + @param ppath local path to get the repository infos + @type str + @return string with ready formated info for display + @rtype str """ args = self.initCommand("log") args.extend( @@ -1335,7 +1395,7 @@ Public method to signal the support of user settable command options. @return flag indicating the support of user settable command options - (boolean) + @rtype bool """ return False @@ -1347,8 +1407,10 @@ """ Public method to normalize a url for Mercurial. - @param url url string (string) - @return properly normalized url for mercurial (string) + @param url url string + @type str + @return properly normalized url for mercurial + @rtype str """ url = url.replace("\\", "/") if url.endswith("/"): @@ -1360,9 +1422,12 @@ """ Public method used to copy a file/directory. - @param name file/directory name to be copied (string) + @param name file/directory name to be copied + @type str @param project reference to the project object - @return flag indicating successful operation (boolean) + @type Project + @return flag indicating successful operation + @rtype bool """ from .HgCopyDialog import HgCopyDialog @@ -1392,10 +1457,11 @@ """ Public method to get the list of tags. - @param withType flag indicating to get the tag type as well (boolean) - @return list of tags (list of string) or list of tuples of - tag name and flag indicating a local tag (list of tuple of string - and boolean), if withType is True + @param withType flag indicating to get the tag type as well + @type bool + @return list of tags or list of tuples of tag name and flag indicating + a local tag, if withType is True + @rtype list of str or list of [(str, bool)] """ args = self.initCommand("tags") args.append("--verbose") @@ -1473,7 +1539,8 @@ Public method used to list the available tags or branches. @param tags flag indicating listing of branches or tags - (False = branches, True = tags) + (False = branches, True = tags) + @type bool """ from .HgTagBranchListDialog import HgTagBranchListDialog @@ -1525,7 +1592,8 @@ This method gives the chance to enter the revisions to be compared. - @param name file/directory name to be diffed (string) + @param name file/directory name to be diffed + @type str """ from .HgDiffDialog import HgDiffDialog from .HgRevisionsSelectionDialog import HgRevisionsSelectionDialog @@ -1559,9 +1627,12 @@ Private method to get a file for a specific revision from the repository. - @param name file name to get from the repository (string) - @param rev revision to retrieve (string) - @return contents of the file (string) and an error message (string) + @param name file name to get from the repository + @type str + @param rev revision to retrieve + @type str + @return contents of the file (string) and an error message + @rtype str """ args = self.initCommand("cat") if rev: @@ -1579,9 +1650,12 @@ Public method used to view the difference of a file to the Mercurial repository side-by-side. - @param name file name to be diffed (string) - @param extended flag indicating the extended variant (boolean) - @param revisions tuple of two revisions (tuple of strings) + @param name file name to be diffed + @type str + @param extended flag indicating the extended variant + @type bool + @param revisions tuple of two revisions + @type tuple of (str, str) @exception ValueError raised to indicate an invalid name parameter """ from eric7.UI.CompareDialog import CompareDialog @@ -1648,9 +1722,10 @@ Public method used to browse the log of a file/directory from the Mercurial repository. - @param name file/directory name to show the log of (string) + @param name file/directory name to show the log of + @type str @param isFile flag indicating log for a file is to be shown - (boolean) + @type bool """ from .HgLogBrowserDialog import HgLogBrowserDialog @@ -1737,9 +1812,12 @@ """ Public method used to push changes to a remote Mercurial repository. - @param force flag indicating a forced push (boolean) - @param newBranch flag indicating to push a new branch (boolean) - @param rev revision to be pushed (including all ancestors) (string) + @param force flag indicating a forced push + @type bool + @param newBranch flag indicating to push a new branch + @type bool + @param rev revision to be pushed (including all ancestors) + @type str """ args = self.initCommand("push") args.append("-v") @@ -1761,8 +1839,8 @@ """ Public method to show information about the heads of the repository. - @param mode mode of the operation (string, one of heads, parents, - tip) + @param mode mode of the operation (one of 'heads', 'parents', 'tip') + @type str """ if mode not in ("heads", "parents", "tip"): mode = "heads" @@ -1873,9 +1951,11 @@ """ Public method used to resolve conflicts of a file/directory. - @param name file/directory name to be resolved (string) + @param name file/directory name to be resolved + @type str @param unresolve flag indicating to mark the file/directory as - unresolved (boolean) + unresolved + @type bool """ args = self.initCommand("resolve") if unresolve: @@ -1903,8 +1983,8 @@ """ Public method to abort an uncommitted merge. - @return flag indicating, that the abortion contained an add - or delete (boolean) + @return flag indicating, that the abortion contained an add or delete + @rtype bool """ if self.version >= (4, 5, 0): args = self.initCommand("merge") @@ -2095,9 +2175,12 @@ """ Public method to create the ignore file. - @param name directory name to create the ignore file in (string) - @param autoAdd flag indicating to add it automatically (boolean) + @param name directory name to create the ignore file in + @type str + @param autoAdd flag indicating to add it automatically + @type bool @return flag indicating success + @rtype bool """ status = False ignorePatterns = [ @@ -2439,7 +2522,8 @@ Public method to import a patch file. @return flag indicating, that the import contained an add, a delete - or a change to the project file (boolean) + or a change to the project file + @rtype bool """ from .HgImportDialog import HgImportDialog @@ -2537,8 +2621,10 @@ Public method to change the phase of revisions. @param data tuple giving phase data (list of revisions, phase, flag - indicating a forced operation) (list of strings, string, boolean) - @return flag indicating success (boolean) + indicating a forced operation) + @type tuple of (list of str, str, bool) + @return flag indicating success + @rtype bool @exception ValueError raised to indicate an invalid phase """ from .HgPhaseDialog import HgPhaseDialog @@ -2581,9 +2667,10 @@ """ Public method to copy changesets from another branch. - @param revs list of revisions to show in the revisions pane (list of - strings) - @return flag indicating that the project should be reread (boolean) + @param revs list of revisions to show in the revisions pane + @type list of str + @return flag indicating that the project should be reread + @rtype bool """ from .HgGraftDialog import HgGraftDialog @@ -2735,7 +2822,8 @@ Public method to get the path to the .hgsub file containing the definitions of sub-repositories. - @return full path of the .hgsub file (string) + @return full path of the .hgsub file + @rtype str """ ppath = self.__projectHelper.getProject().getProjectPath() return os.path.join(ppath, ".hgsub") @@ -2744,7 +2832,8 @@ """ Public method to check, if the project might have sub-repositories. - @return flag indicating the existence of sub-repositories (boolean) + @return flag indicating the existence of sub-repositories + @rtype bool """ hgsub = self.getHgSubPath() return os.path.isfile(hgsub) and os.stat(hgsub).st_size > 0 @@ -2920,7 +3009,8 @@ """ Public method to check, if pull is possible. - @return flag indicating pull capability (boolean) + @return flag indicating pull capability + @rtype bool """ return self.__defaultConfigured @@ -2928,7 +3018,8 @@ """ Public method to check, if push is possible. - @return flag indicating push capability (boolean) + @return flag indicating push capability + @rtype bool """ return self.__defaultPushConfigured or self.__defaultConfigured @@ -2936,7 +3027,8 @@ """ Private slot to handle a change of the Mercurial configuration file. - @param path name of the changed file (string) + @param path name of the changed file + @type str """ if self.__client: ok, err = self.__client.restartServer() @@ -3001,8 +3093,10 @@ """ Public method to check, if an extension is active. - @param extensionName name of the extension to check for (string) - @return flag indicating an active extension (boolean) + @param extensionName name of the extension to check for + @type str + @return flag indicating an active extension + @rtype bool """ extensionName = extensionName.strip() isActive = extensionName in self.__activeExtensions @@ -3013,8 +3107,10 @@ """ Public method to get a reference to an extension object. - @param extensionName name of the extension (string) - @return reference to the extension object (boolean) + @param extensionName name of the extension + @type str + @return reference to the extension object + @rtype bool """ return self.__extensions[extensionName] @@ -3028,10 +3124,14 @@ project browsers. @param browser reference to the project browser object + @type ProjectBaseBrowser @param project reference to the project object + @type Project @param isTranslationsBrowser flag indicating, the helper is requested for the translations browser (this needs some special treatment) + @type bool @return the project browser helper object + @rtype HgProjectBrowserHelper """ from .ProjectBrowserHelper import HgProjectBrowserHelper @@ -3042,7 +3142,9 @@ Public method to instantiate a helper object for the project. @param project reference to the project object + @type Project @return the project helper object + @rtype HgProjectHelper """ # find the root of the repo repodir = project.getProjectPath() @@ -3091,7 +3193,8 @@ """ Public method to get a reference to the command server interface. - @return reference to the client (HgClient) + @return reference to the client + @rtype HgClient """ if self.__client is None: self.__createClient(self.__repoDir) @@ -3116,9 +3219,11 @@ thread. @param interval check interval for the monitor thread in seconds - (integer) - @param project reference to the project object (Project) - @return reference to the monitor thread (QThread) + @type int + @param project reference to the project object + @type Project + @return reference to the monitor thread + @rtype HgStatusMonitorThread """ from .HgStatusMonitorThread import HgStatusMonitorThread @@ -3146,7 +3251,8 @@ """ Public method to get the list of bookmarks. - @return list of bookmarks (list of string) + @return list of bookmarks + @rtype list of str """ args = self.initCommand("bookmarks") @@ -3170,8 +3276,10 @@ """ Public method to define a bookmark. - @param revision revision to set bookmark for (string) - @param bookmark name of the bookmark (string) + @param revision revision to set bookmark for + @type str + @param bookmark name of the bookmark + @type str """ from .HgBookmarkDialog import HgBookmarkDialog @@ -3206,7 +3314,8 @@ """ Public method to delete a bookmark. - @param bookmark name of the bookmark (string) + @param bookmark name of the bookmark + @type str """ if bookmark: ok = True @@ -3258,8 +3367,10 @@ """ Public method to move a bookmark. - @param revision revision to set bookmark for (string) - @param bookmark name of the bookmark (string) + @param revision revision to set bookmark for + @type str + @param bookmark name of the bookmark + @type str """ from .HgBookmarkDialog import HgBookmarkDialog @@ -3319,8 +3430,10 @@ """ Private method to get the list of incoming or outgoing bookmarks. - @param incoming flag indicating to get incoming bookmarks (boolean) - @return list of bookmarks (list of string) + @param incoming flag indicating to get incoming bookmarks + @type bool + @return list of bookmarks + @rtype list of str """ bookmarksList = []
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/ConfigurationPage/SubversionPage.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/ConfigurationPage/SubversionPage.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,6 +26,7 @@ Constructor @param plugin reference to the plugin object + @type VcsPySvnPlugin """ super().__init__() self.setupUi(self)
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/ProjectBrowserHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/ProjectBrowserHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -37,12 +37,18 @@ Constructor @param vcsObject reference to the vcs object + @type Subversion @param browserObject reference to the project browser object + @type ProjectBaseBrowser @param projectObject reference to the project object + @type Project @param isTranslationsBrowser flag indicating, the helper is requested for the translations browser (this needs some special treatment) - @param parent parent widget (QWidget) - @param name name of this object (string) + @type bool + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ VcsProjectBrowserHelper.__init__( self, @@ -62,8 +68,10 @@ VCS status and the file status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ if self.browser.currentItem().data(1) == self.vcs.vcsName(): for act in self.vcsMenuActions: @@ -98,8 +106,10 @@ VCS status and the files status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ vcsName = self.vcs.vcsName() items = self.browser.getSelectedItems() @@ -138,8 +148,10 @@ VCS status and the directory status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ if self.browser.currentItem().data(1) == self.vcs.vcsName(): for act in self.vcsDirMenuActions: @@ -164,8 +176,10 @@ VCS status and the directory status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ vcsName = self.vcs.vcsName() items = self.browser.getSelectedItems() @@ -203,6 +217,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ self.vcsMenuActions = [] self.vcsAddMenuActions = [] @@ -392,6 +407,7 @@ project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ self.vcsMultiMenuActions = [] self.vcsAddMultiMenuActions = [] @@ -542,6 +558,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return @@ -586,6 +603,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return @@ -735,6 +753,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return @@ -1108,7 +1127,9 @@ """ Private method to check, if items contain file type items. - @param items items to check (list of QTreeWidgetItems) - @return flag indicating items contain file type items (boolean) + @param items items to check + @type list of QTreeWidgetItems + @return flag indicating items contain file type items + @rtype bool """ return any(isinstance(itm, ProjectBrowserFileItem) for itm in items)
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -27,9 +27,13 @@ Constructor @param vcsObject reference to the vcs object + @type Subversion @param projectObject reference to the project object - @param parent parent widget (QWidget) - @param name name of this object (string) + @type Project + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ VcsProjectHelper.__init__(self, vcsObject, projectObject, parent, name) @@ -37,7 +41,8 @@ """ Public method to get a list of all actions. - @return list of all actions (list of EricAction) + @return list of all actions + @rtype list of EricAction """ return self.actions[:] @@ -617,7 +622,8 @@ """ Public method to generate the VCS menu. - @param menu reference to the menu to be populated (QMenu) + @param menu reference to the menu to be populated + @type QMenu """ menu.clear() @@ -681,9 +687,10 @@ """ Public slot to initialize the VCS toolbar. - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ self.__toolbar = QToolBar(self.tr("Subversion (pysvn)"), ui) self.__toolbar.setObjectName("PySvnToolbar") @@ -723,9 +730,10 @@ """ Public method to remove a toolbar created by initToolbar(). - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ ui.removeToolBar(self.__toolbar) ui.unregisterToolbar("pysvn")
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnBlameDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnBlameDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -31,7 +31,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -58,7 +60,8 @@ """ Public slot to start the svn blame command. - @param fn filename to show the blame for (string) + @param fn filename to show the blame for + @type str """ self.blameList.clear() self.errorGroup.hide() @@ -102,7 +105,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -119,10 +123,14 @@ """ Private method to generate a blame item in the blame list. - @param revision revision string (string) - @param author author of the change (string) - @param lineno linenumber (string) - @param text line of text from the annotated file (string) + @param revision revision string + @type str + @param author author of the change + @type str + @param lineno linenumber + @type str + @param text line of text from the annotated file + @type str """ itm = QTreeWidgetItem( self.blameList, @@ -135,7 +143,8 @@ """ Private slot to show an error message. - @param msg error message to show (string) + @param msg error message to show + @type str """ self.errorGroup.show() self.errors.insertPlainText(msg)
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnChangeListsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnChangeListsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -31,7 +31,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -55,8 +57,10 @@ """ Private slot to handle the selection of a new item. - @param current current item (QListWidgetItem) - @param previous previous current item (QListWidgetItem) + @param current current item + @type QListWidgetItem + @param previous previous current item + @type QListWidgetItem """ self.filesList.clear() if current is not None: @@ -68,7 +72,8 @@ """ Public slot to populate the data. - @param path directory name to show change lists for (string) + @param path directory name to show change lists for + @type str """ self.changeListsDict = {} self.cancelled = False @@ -104,7 +109,7 @@ self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setDefault(True) if len(self.changeListsDict) == 0: - self.changeLists.addItem(self.tr("No changelists found")) + self.changeLists.addItem(self.tr("No change lists found")) self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setFocus( Qt.FocusReason.OtherFocusReason ) @@ -116,7 +121,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close()
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnCommandDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnCommandDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -29,10 +29,14 @@ """ Constructor - @param argvList history list of commandline arguments (list of strings) - @param wdList history list of working directories (list of strings) - @param ppath pathname of the project directory (string) - @param parent parent widget of this dialog (QWidget) + @param argvList history list of commandline arguments + @type list of str + @param wdList history list of working directories + @type list of str + @param ppath pathname of the project directory + @type str + @param parent parent widget of this dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -69,7 +73,8 @@ """ Private method used to enable/disable the OK-button. - @param text ignored + @param text text of the command combobox + @type str """ self.okButton.setDisabled(self.commandCombo.currentText() == "") @@ -77,6 +82,7 @@ """ Public method to retrieve the data entered into this dialog. - @return a tuple of argv, workdir + @return a tuple containing argv, workdir + @rtype tuple of (str, str) """ return (self.commandCombo.currentText(), self.workdirPicker.currentText())
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnCommitDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnCommitDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -33,7 +33,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent, Qt.WindowType.Window) self.setupUi(self) @@ -54,7 +56,8 @@ """ Protected method called when the dialog is about to be shown. - @param evt the event (QShowEvent) + @param evt the event + @type QShowEvent """ commitMessages = self.__vcs.vcsCommitMessages() self.recentComboBox.clear() @@ -70,7 +73,8 @@ This method has the side effect of saving the 20 most recent commit messages for reuse. - @return the log message (string) + @return the log message + @rtype str """ msg = self.logEdit.toPlainText() if msg: @@ -79,18 +83,20 @@ def hasChangelists(self): """ - Public method to check, if the user entered some changelists. + Public method to check, if the user entered some change lists. - @return flag indicating availability of changelists (boolean) + @return flag indicating availability of change lists + @rtype bool """ return len(self.changeLists.selectedItems()) > 0 def changelistsData(self): """ - Public method to retrieve the changelists data. + Public method to retrieve the change lists data. - @return tuple containing the changelists (list of strings) and a flag - indicating to keep changelists (boolean) + @return tuple containing the change lists and a flag indicating to keep + the change lists + @rtype tuple of (list of str, bool) """ slists = [ line.text().strip() @@ -107,7 +113,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel): self.logEdit.clear()
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnCopyDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnCopyDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -27,10 +27,14 @@ """ Constructor - @param source name of the source file/directory (string) - @param parent parent widget (QWidget) - @param move flag indicating a move operation (boolean) - @param force flag indicating a forced operation (boolean) + @param source name of the source file/directory + @type str + @param parent parent widget + @type QWidget + @param move flag indicating a move operation + @type bool + @param force flag indicating a forced operation + @type bool """ super().__init__(parent) self.setupUi(self) @@ -58,8 +62,8 @@ """ Public method to retrieve the copy data. - @return the target name (string) and a flag indicating - the operation should be enforced (boolean) + @return the target name and a flag indicating the operation should be enforced + @rtype tuple of (str, bool) """ target = self.targetPicker.text() if not os.path.isabs(target): @@ -72,7 +76,8 @@ """ Private slot to handle changes of the target. - @param txt contents of the target edit (string) + @param txt contents of the target edit + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( os.path.isabs(txt) or os.path.dirname(txt) == ""
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -28,12 +28,16 @@ """ Constructor - @param text text to be shown by the label (string) + @param text text to be shown by the label + @type str @param command svn command to be executed (display purposes only) - (string) - @param pysvnClient reference to the pysvn client object (pysvn.Client) - @param parent parent widget (QWidget) - @param log optional log message (string) + @type str + @param pysvnClient reference to the pysvn client object + @type pysvn.Client + @param parent parent widget + @type QWidget + @param log optional log message + @type str """ super().__init__(parent) self.setupUi(self) @@ -69,6 +73,7 @@ Protected method called by the client to send events. @param eventDict dictionary containing the notification event + @type dict """ msg = "" if eventDict["action"] == pysvn.wc_notify_action.update_completed: @@ -106,7 +111,8 @@ """ Public slot to show a message. - @param msg message to show (string) + @param msg message to show + @type str """ self.resultbox.insertPlainText(msg) self.resultbox.ensureCursorVisible() @@ -116,7 +122,8 @@ """ Public slot to show an error message. - @param msg error message to show (string) + @param msg error message to show + @type str """ self.errorGroup.show() self.errors.insertPlainText(msg) @@ -141,7 +148,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -152,6 +160,7 @@ """ Public method to check, if the last action contained an add or delete. - @return flag indicating the presence of an add or delete (boolean) + @return flag indicating the presence of an add or delete + @rtype bool """ return self.__hasAddOrDelete
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDialogMixin.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDialogMixin.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,7 +23,8 @@ """ Constructor - @param log optional log message (string) + @param log optional log message + @type str """ self.shouldCancel = False self.logMessage = log @@ -45,6 +46,7 @@ Protected method called by the client to check for cancellation. @return flag indicating a cancellation + @rtype bool """ QApplication.processEvents() return self.shouldCancel @@ -53,15 +55,19 @@ """ Protected method called by the client to get login information. - @param realm name of the realm of the requested credentials (string) - @param username username as supplied by subversion (string) + @param realm name of the realm of the requested credentials + @type str + @param username username as supplied by subversion + @type str @param may_save flag indicating, that subversion is willing to save - the answers returned (boolean) + the answers returned + @type bool @return tuple of four values (retcode, username, password, save). Retcode should be True, if username and password should be used by subversion, username and password contain the relevant data as strings and save is a flag indicating, that username and password should be saved. + @rtype tuple of (bool, str, str, bool) """ from .SvnLoginDialog import SvnLoginDialog @@ -82,10 +88,12 @@ ssl server certificate. @param trust_dict dictionary containing the trust data + @type dict @return tuple of three values (retcode, acceptedFailures, save). - Retcode should be true, if the certificate should be accepted, + Retcode should be True, if the certificate should be accepted, acceptedFailures should indicate the accepted certificate failures and save should be True, if subversion should save the certificate. + @rtype tuple of (bool, list of str, bool) """ from eric7.EricWidgets import EricMessageBox @@ -135,7 +143,8 @@ """ Protected method called by the client to request a log message. - @return a flag indicating success and the log message (string) + @return a flag indicating success and the log message + @rtype str """ from .SvnCommitDialog import SvnCommitDialog
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDiffDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDiffDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -39,7 +39,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -75,8 +77,10 @@ Private method to get a pysvn revision object for the given version number. - @param version revision (integer or string) - @return revision object (pysvn.Revision) + @param version revision + @type int or str + @return revision object + @rtype pysvn.Revision """ if isinstance(version, int): return pysvn.Revision(pysvn.opt_revision_kind.number, version) @@ -97,8 +101,10 @@ """ Private method to get a string descripion of the diff summary. - @param summaryKind (pysvn.diff_summarize.summarize_kind) - @return one letter string indicating the change type (string) + @param summaryKind + @type pysvn.diff_summarize.summarize_kind + @return one letter string indicating the change type + @rtype str """ if summaryKind == pysvn.diff_summarize_kind.delete: return "D" @@ -123,14 +129,19 @@ """ Public slot to start the svn diff command. - @param fn filename to be diffed (string) - @param versions list of versions to be diffed (list of up to 2 integer - or None) - @param urls list of repository URLs (list of 2 strings) + @param fn filename to be diffed + @type str + @param versions list of versions to be diffed + @type list of up to 2 int or None + @param urls list of repository URLs + @type list of [str, str] @param summary flag indicating a summarizing diff - (only valid for URL diffs) (boolean) - @param pegRev revision number the filename is valid (integer) - @param refreshable flag indicating a refreshable diff (boolean) + (only valid for URL diffs) + @type bool + @param pegRev revision number the filename is valid + @type int + @param refreshable flag indicating a refreshable diff + @type bool """ self.refreshButton.setVisible(refreshable) @@ -291,7 +302,8 @@ """ Private method to append text to the end of the contents pane. - @param line line of text to insert (string) + @param line line of text to insert + @type str """ tc = self.contents.textCursor() tc.movePosition(QTextCursor.MoveOperation.End) @@ -303,8 +315,10 @@ """ Private method to extract the file name out of a file separator line. - @param line line to be processed (string) - @return extracted file name (string) + @param line line to be processed + @type str + @return extracted file name + @rtype str """ f = line.split(None, 1)[1] f = f.rsplit(None, 2)[0] @@ -314,7 +328,8 @@ """ Private slot to process a line giving the old/new file. - @param line line to be processed (string) + @param line line to be processed + @type str """ if line.startswith("---"): self.__oldFileLine = self.paras @@ -353,7 +368,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -369,7 +385,8 @@ """ Private slot to handle the selection of a file. - @param index activated row (integer) + @param index activated row + @type int """ para = self.filesCombo.itemData(index) @@ -480,7 +497,8 @@ """ Private slot to show an error message. - @param msg error message to show (string) + @param msg error message to show + @type str """ self.errorGroup.show() self.errors.insertPlainText(msg)
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDiffHighlighter.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDiffHighlighter.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,7 +22,8 @@ """ Constructor - @param doc reference to the text document (QTextDocument) + @param doc reference to the text document + @type QTextDocument """ super().__init__(doc)
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnInfoDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnInfoDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -33,7 +33,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -56,8 +58,10 @@ """ Public slot to start the svn info command. - @param projectPath path name of the project (string) - @param fn file or directory name relative to the project (string) + @param projectPath path name of the project + @type str + @param fn file or directory name relative to the project + @type str """ cwd = os.getcwd() os.chdir(projectPath) @@ -176,7 +180,8 @@ """ Private slot to show an error message. - @param msg error message to show (string) + @param msg error message to show + @type str """ infoStr = "<p>{0}</p>".format(msg) self.infoBrowser.setHtml(infoStr)
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnLogBrowserDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnLogBrowserDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -41,7 +41,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -103,7 +105,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ self.__position = self.pos() @@ -185,13 +188,19 @@ """ Private method to generate a log tree entry. - @param author author info (string) - @param date date info (integer) - @param message text of the log message (string) - @param revision revision info (string or pysvn.opt_revision_kind) + @param author author info + @type str + @param date date info + @type int + @param message text of the log message + @type str + @param revision revision info + @type str or pysvn.opt_revision_kind @param changedPaths list of pysvn dictionary like objects containing info about the changed files/directories - @return reference to the generated item (QTreeWidgetItem) + @type dict like + @return reference to the generated item + @rtype QTreeWidgetItem """ if revision == "": rev = "" @@ -242,10 +251,15 @@ Private method to generate a changed files tree entry. @param action indicator for the change action ("A", "D" or "M") - @param path path of the file in the repository (string) - @param copyFrom path the file was copied from (None, string) - @param copyRev revision the file was copied from (None, string) - @return reference to the generated item (QTreeWidgetItem) + @type str + @param path path of the file in the repository + @type str + @param copyFrom path the file was copied from + @type str + @param copyRev revision the file was copied from + @type str + @return reference to the generated item + @rtype QTreeWidgetItem """ itm = QTreeWidgetItem( self.filesTree, [self.flags[action], path, copyFrom, copyRev] @@ -259,7 +273,8 @@ """ Private method to retrieve log entries from the repository. - @param startRev revision number to start from (integer, string) + @param startRev revision number to start from + @type tuple of (int, str) """ fetchLimit = 10 self._reset() @@ -346,9 +361,10 @@ """ Public slot to start the svn log command. - @param fn filename to show the log for (string) + @param fn filename to show the log for + @type str @param isFile flag indicating log for a file is to be shown - (boolean) + @type bool """ self.sbsCheckBox.setEnabled(isFile) self.sbsCheckBox.setVisible(isFile) @@ -379,9 +395,12 @@ """ Private method to do a diff of two revisions. - @param rev1 first revision number (integer) - @param rev2 second revision number (integer) - @param peg_rev revision number to use as a reference (integer) + @param rev1 first revision number + @type int + @param rev2 second revision number + @type int + @param peg_rev revision number to use as a reference + @type int """ from .SvnDiffDialog import SvnDiffDialog @@ -399,7 +418,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -412,8 +432,10 @@ """ Private slot called, when the current item of the log tree changes. - @param current reference to the new current item (QTreeWidgetItem) - @param previous reference to the old current item (QTreeWidgetItem) + @param current reference to the new current item + @type QTreeWidgetItem + @param previous reference to the old current item + @type QTreeWidgetItem """ if current is not None: self.messageEdit.setPlainText(current.data(0, self.__messageRole)) @@ -511,7 +533,8 @@ """ Private slot to show an error message. - @param msg error message to show (string) + @param msg error message to show + @type str """ EricMessageBox.critical(self, self.tr("Subversion Error"), msg) @@ -520,7 +543,8 @@ """ Private slot called, when the from date changes. - @param date new date (QDate) + @param date new date + @type QDate """ self.__filterLogs() @@ -529,7 +553,8 @@ """ Private slot called, when the from date changes. - @param date new date (QDate) + @param date new date + @type QDate """ self.__filterLogs() @@ -548,7 +573,8 @@ """ Private slot called, when a filter expression is entered. - @param txt filter expression (string) + @param txt filter expression + @type str """ self.__filterLogs() @@ -596,7 +622,8 @@ """ Private slot called, when the stop on copy/move checkbox is clicked. - @param checked flag indicating the check box state (boolean) + @param checked flag indicating the check box state + @type bool """ self.vcs.getPlugin().setPreferences( "StopLogOnCopy", int(self.stopCheckBox.isChecked())
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnLoginDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnLoginDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -21,11 +21,15 @@ """ Constructor - @param realm name of the realm of the requested credentials (string) - @param username username as supplied by subversion (string) + @param realm name of the realm of the requested credentials + @type str + @param username username as supplied by subversion + @type str @param may_save flag indicating, that subversion is willing to save - the answers returned (boolean) - @param parent reference to the parent widget (QWidget) + the answers returned + @type bool + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -45,7 +49,8 @@ """ Public method to retrieve the login data. - @return tuple of three values (username, password, save) + @return tuple containing the username, the password and a flag to save the data + @rtype tuple of (str, str, bool) """ return ( self.usernameEdit.text(),
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnMergeDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnMergeDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -25,12 +25,15 @@ Constructor @param mergelist1 list of previously entered URLs/revisions - (list of strings) + @type list of str @param mergelist2 list of previously entered URLs/revisions - (list of strings) - @param targetlist list of previously entered targets (list of strings) - @param force flag indicating a forced merge (boolean) - @param parent parent widget (QWidget) + @type list of str + @param targetlist list of previously entered targets + @type list of str + @param force flag indicating a forced merge + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -77,7 +80,8 @@ """ Private slot to handle the tag1Combo editTextChanged signal. - @param text text of the combo (string) + @param text text of the combo + @type str """ self.__enableOkButton() @@ -86,7 +90,8 @@ """ Private slot to handle the tag2Combo editTextChanged signal. - @param text text of the combo (string) + @param text text of the combo + @type str """ self.__enableOkButton() @@ -95,7 +100,8 @@ Public method to retrieve the merge data. @return tuple naming two tag names or two revisions, a target and - a flag indicating a forced merge (string, string, string, boolean) + a flag indicating a forced merge + @rtype tuple of (str, str, str, bool) """ return ( self.tag1Combo.currentText(),
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnNewProjectOptionsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnNewProjectOptionsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -32,7 +32,9 @@ Constructor @param vcs reference to the version control object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -71,7 +73,8 @@ """ Private slot to handle a change of the project directory. - @param txt name of the project directory (string) + @param txt name of the project directory + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( bool(txt) @@ -101,7 +104,8 @@ """ Private slot to handle the change of the layout checkbox. - @param checked flag indicating the state of the checkbox (boolean) + @param checked flag indicating the state of the checkbox + @type bool """ self.vcsTagLabel.setEnabled(checked) self.vcsTagEdit.setEnabled(checked) @@ -136,7 +140,8 @@ """ Private slot to handle changes of the URL. - @param txt current text of the line edit (string) + @param txt current text of the line edit + @type str """ enable = "://" not in txt self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled(enable) @@ -145,8 +150,9 @@ """ Public slot to retrieve the data entered into the dialog. - @return a tuple of a string (project directory) and a dictionary + @return a tuple containing the project directory and a dictionary containing the data entered. + @rtype tuple of (str, dict) """ scheme = self.protocolCombo.currentText() url = self.vcsUrlPicker.text()
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnOptionsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnOptionsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -31,8 +31,11 @@ Constructor @param vcs reference to the version control object + @type Subversion @param project reference to the project object - @param parent parent widget (QWidget) + @type Project + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -101,7 +104,8 @@ """ Private slot to handle changes of the URL. - @param txt current text of the line edit (string) + @param txt current text of the line edit + @type str """ enable = "://" not in txt self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled(enable) @@ -111,6 +115,7 @@ Public slot to retrieve the data entered into the dialog. @return a dictionary containing the data entered + @rtype dict """ scheme = self.protocolCombo.currentText() url = self.vcsUrlPicker.text()
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnPropDelDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnPropDelDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,7 +22,9 @@ Constructor @param recursive flag indicating a recursive set is requested - @param parent parent widget (QWidget) + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -39,7 +41,8 @@ """ Private method used to enable/disable the OK-button. - @param text ignored + @param text text of the property name edit + @type str """ self.okButton.setDisabled(text == "") @@ -49,6 +52,6 @@ @return tuple of two values giving the property name and a flag indicating, that this property should be applied recursively. - (string, boolean) + @rtype tuple of (str, bool) """ return (self.propNameEdit.text(), self.recurseCheckBox.isChecked())
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnPropListDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnPropListDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -38,7 +38,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -85,9 +87,12 @@ """ Private method to generate a properties item in the properties list. - @param path file/directory name the property applies to (string) - @param propName name of the property (string) - @param propValue value of the property (string) + @param path file/directory name the property applies to + @type str + @param propName name of the property + @type str + @param propValue value of the property + @type str """ QTreeWidgetItem(self.propsList, [path, propName, propValue]) @@ -95,8 +100,10 @@ """ Public slot to start the svn status command. - @param fn filename(s) (string or list of strings) + @param fn filename(s) + @type str or list of str @param recursive flag indicating a recursive list is requested + @type bool """ self.errorGroup.hide() @@ -162,7 +169,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -182,7 +190,8 @@ """ Private slot to show an error message. - @param msg error message to show (string) + @param msg error message to show + @type str """ self.errorGroup.show() self.errors.insertPlainText(msg)
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnPropSetDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnPropSetDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,7 +22,9 @@ Constructor @param recursive flag indicating a recursive set is requested - @param parent parent widget (QWidget) + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -33,9 +35,9 @@ """ Public slot used to retrieve the data entered into the dialog. - @return tuple of three values giving the property name, the text - of the property and a flag indicating, that this property - should be applied recursively. (string, string, boolean) + @return tuple containing the property name, the text of the property and + a flag indicating, that this property should be applied recursively. + @rtype tuple of (str, str, bool) """ return ( self.propNameEdit.text(),
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnRelocateDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnRelocateDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -21,8 +21,10 @@ """ Constructor - @param currUrl current repository URL (string) - @param parent parent widget (QWidget) + @param currUrl current repository URL + @type str + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -37,7 +39,8 @@ """ Public slot used to retrieve the data entered into the dialog. - @return the new repository URL (string) and an indication, if - the relocate is inside the repository (boolean) + @return the new repository URL and an indication, if the relocate is inside + the repository + @rtype tuple of (str, bool) """ return self.newUrlEdit.text(), self.insideCheckBox.isChecked()
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnRepoBrowserDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnRepoBrowserDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -38,8 +38,11 @@ Constructor @param vcs reference to the vcs object - @param mode mode of the dialog (string, "browse" or "select") - @param parent parent widget (QWidget) + @type Subversion + @param mode mode of the dialog ("browse" or "select") + @type str + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -96,16 +99,24 @@ """ Private method to generate a tree item in the repository tree. - @param parent parent of the item to be created (QTreeWidget or - QTreeWidgetItem) - @param repopath path of the item (string) - @param revision revision info (string or pysvn.opt_revision_kind) - @param author author info (string) - @param size size info (integer) - @param date date info (integer) - @param nodekind node kind info (pysvn.node_kind) - @param url url of the entry (string) - @return reference to the generated item (QTreeWidgetItem) + @param parent parent of the item to be created + @type QTreeWidget or QTreeWidgetItem + @param repopath path of the item + @type str + @param revision revision info + @type str or pysvn.opt_revision_kind + @param author author info + @type str + @param size size info + @type int + @param date date info + @type int + @param nodekind node kind info + @type pysvn.node_kind + @param url url of the entry + @type str + @return reference to the generated item + @rtype QTreeWidgetItem """ path = url if repopath == "/" else url.split("/")[-1] @@ -143,9 +154,10 @@ """ Private method to perform the svn list command. - @param url the repository URL to browser (string) + @param url the repository URL to browser + @type str @param parent reference to the item, the data should be appended to - (QTreeWidget or QTreeWidgetItem) + @type QTreeWidget or QTreeWidgetItem """ if parent is None: parent = self.repoTree @@ -212,8 +224,10 @@ """ Private method to normalite the url. - @param url the url to normalize (string) - @return normalized URL (string) + @param url the url to normalize + @type str + @return normalized URL + @rtype str """ if url.endswith("/"): return url[:-1] @@ -223,7 +237,8 @@ """ Public slot to start the svn info command. - @param url the repository URL to browser (string) + @param url the repository URL to browser + @type str """ self.repoTree.clear() @@ -253,7 +268,8 @@ """ Private slot called when an item is expanded. - @param item reference to the item to be expanded (QTreeWidgetItem) + @param item reference to the item to be expanded + @type QTreeWidgetItem """ if not self.__ignoreExpand: url = item.data(0, self.__urlRole) @@ -264,7 +280,8 @@ """ Private slot called when an item is collapsed. - @param item reference to the item to be collapsed (QTreeWidgetItem) + @param item reference to the item to be collapsed + @type QTreeWidgetItem """ for child in item.takeChildren(): del child @@ -281,7 +298,8 @@ """ Private slot to show an error message. - @param msg error message to show (string) + @param msg error message to show + @type str """ EricMessageBox.critical(self, self.tr("Subversion Error"), msg) @@ -298,7 +316,8 @@ """ Public method to retrieve the selected repository URL. - @return the selected repository URL (string) + @return the selected repository URL + @rtype str """ items = self.repoTree.selectedItems() if len(items) == 1:
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnRevisionSelectionDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnRevisionSelectionDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,7 +23,8 @@ """ Constructor - @param parent parent widget of the dialog (QWidget) + @param parent parent widget of the dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -39,7 +40,9 @@ Private method to generate the revision. @param no revision number to generate (1 or 2) - @return revision (integer or string) + @type int + @return revision + @rtype int or str """ if no == 1: numberButton = self.number1Button @@ -89,7 +92,8 @@ """ Public method to get the revisions. - @return list two integers or strings + @return list containing the selected revisions + @rtype list of [int or str, int or str] """ rev1 = self.__getRevision(1) rev2 = self.__getRevision(2)
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnStatusDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnStatusDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -45,7 +45,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -234,18 +236,30 @@ """ Private method to generate a status item in the status list. - @param changelist name of the changelist (string) - @param status text status (pysvn.wc_status_kind) - @param propStatus property status (pysvn.wc_status_kind) - @param locked locked flag (boolean) - @param history history flag (boolean) - @param switched switched flag (boolean) - @param lockinfo lock indicator (string) - @param uptodate up to date flag (boolean) - @param revision revision (integer) - @param change revision of last change (integer) - @param author author of the last change (string) - @param path path of the file or directory (string) + @param changelist name of the changelist + @type str + @param status text status + @type pysvn.wc_status_kind + @param propStatus property status + @type pysvn.wc_status_kind + @param locked locked flag + @type bool + @param history history flag + @type bool + @param switched switched flag + @type bool + @param lockinfo lock indicator + @type str + @param uptodate up to date flag + @type bool + @param revision revision + @type int + @param change revision of last change + @type int + @param author author of the last change + @type str + @param path path of the file or directory + @type str """ statusText = self.tr(svnStatusMap[status]) itm = QTreeWidgetItem(self.statusList) @@ -298,7 +312,7 @@ Public slot to start the svn status command. @param fn filename(s)/directoryname(s) to show the status of - (string or list of strings) + @type str or list of str """ self.errorGroup.hide() @@ -352,7 +366,7 @@ try: with EricMutexLocker(self.vcs.vcsExecutionMutex): for name in fnames: - # step 1: determine changelists and their files + # step 1: determine change lists and their files changelistsDict = {} if hasattr(self.client, "get_changelist"): if recurse: @@ -503,7 +517,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -523,7 +538,8 @@ """ Private slot to show an error message. - @param msg error message to show (string) + @param msg error message to show + @type str """ self.errorGroup.show() self.errors.insertPlainText(msg) @@ -573,8 +589,10 @@ """ Private slot to act upon item changes. - @param item reference to the changed item (QTreeWidgetItem) - @param column index of column that changed (integer) + @param item reference to the changed item + @type QTreeWidgetItem + @param column index of column that changed + @type int """ if column == self.__toBeCommittedColumn: self.__updateCommitButton() @@ -636,7 +654,8 @@ """ Private slot to show the context menu of the status list. - @param coord the position of the mouse pointer (QPoint) + @param coord the position of the mouse pointer + @type QPoint """ self.menu.popup(self.statusList.mapToGlobal(coord)) @@ -903,7 +922,7 @@ def __removeFromChangelist(self): """ - Private slot to remove entries from their changelists. + Private slot to remove entries from their change lists. """ names = [ os.path.join(self.dname, itm.text(self.__pathColumn)) @@ -927,6 +946,7 @@ Private method to retrieve all entries the user wants to commit. @return list of all items, the user has checked + @rtype list of QTreeWidgetItem """ commitableItems = [] for index in range(self.statusList.topLevelItemCount()): @@ -940,6 +960,7 @@ Private method to retrieve all entries, that have a modified status. @return list of all items with a modified status + @rtype list of QTreeWidgetItem """ modifiedItems = [] for itm in self.statusList.selectedItems(): @@ -956,6 +977,7 @@ unversioned status. @return list of all items with an unversioned status + @rtype list of QTreeWidgetItem """ unversionedItems = [] for itm in self.statusList.selectedItems(): @@ -968,6 +990,7 @@ Private method to retrieve all entries, that have a missing status. @return list of all items with a missing status + @rtype list of QTreeWidgetItem """ missingItems = [] for itm in self.statusList.selectedItems(): @@ -979,8 +1002,10 @@ """ Private method to retrieve all entries, that have a locked status. - @param indicators list of indicators to check against (list of strings) + @param indicators list of indicators to check against + @type list of str @return list of all items with a locked status + @rtype list of QTreeWidgetItem """ lockitems = [] for itm in self.statusList.selectedItems(): @@ -994,6 +1019,7 @@ a changelist. @return list of all items belonging to a changelist + @rtype list of QTreeWidgetItem """ clitems = [] for itm in self.statusList.selectedItems(): @@ -1007,6 +1033,7 @@ a changelist. @return list of all items not belonging to a changelist + @rtype list of QTreeWidgetItem """ clitems = [] for itm in self.statusList.selectedItems(): @@ -1018,7 +1045,8 @@ """ Private slot to select or deselect all entries. - @param selected commit selection state to be set (boolean) + @param selected commit selection state to be set + @type bool """ for index in range(self.statusList.topLevelItemCount()): itm = self.statusList.topLevelItem(index)
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnStatusMonitorThread.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnStatusMonitorThread.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,10 +26,14 @@ """ Constructor - @param interval new interval in seconds (integer) - @param project reference to the project object (Project) + @param interval new interval in seconds + @type int + @param project reference to the project object + @type Project @param vcs reference to the version control object - @param parent reference to the parent object (QObject) + @type Subversion + @param parent reference to the parent object + @type QObject """ VcsStatusMonitorThread.__init__(self, interval, project, vcs, parent) @@ -53,8 +57,9 @@ <li>" " path is back at normal</li> </ul> - @return tuple of flag indicating successful operation (boolean) and - a status message in case of non successful operation (string) + @return tuple of flag indicating successful operation and a status message + in case of non successful operation + @rtype tuple of (bool, str) """ self.shouldUpdate = False @@ -157,6 +162,7 @@ by subversion, username and password contain the relevant data as strings and save is a flag indicating, that username and password should be saved. Always returns (False, "", "", False). + @rtype tuple of (bool, str, str, bool) """ return (False, "", "", False) @@ -171,5 +177,6 @@ acceptedFailures should indicate the accepted certificate failures and save should be True, if subversion should save the certificate. Always returns (False, 0, False). + @rtype tuple of (bool, int, bool) """ return (False, 0, False)
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnSwitchDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnSwitchDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -21,11 +21,14 @@ """ Constructor - @param taglist list of previously entered tags (list of strings) - @param reposURL repository path (string) or None - @param standardLayout flag indicating the layout of the - repository (boolean) - @param parent parent widget (QWidget) + @param taglist list of previously entered tags + @type list of str + @param reposURL repository path or None + @type str + @param standardLayout flag indicating the layout of the repository + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -46,7 +49,8 @@ """ Public method to retrieve the tag data. - @return tuple of string and int (tag, tag type) + @return tuple containing the tag and tag type + @rtype tuple of (str, int) """ tag = self.tagCombo.currentText() tagType = 0
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnTagBranchListDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnTagBranchListDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -41,7 +41,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -67,10 +69,13 @@ """ Public slot to start the svn status command. - @param path name of directory to be listed (string) + @param path name of directory to be listed + @type str @param tags flag indicating a list of tags is requested - (False = branches, True = tags) - @return flag indicating success (boolean) + (False = branches, True = tags) + @type bool + @return flag indicating success + @rtype bool """ self.errorGroup.hide() @@ -192,7 +197,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -203,7 +209,8 @@ """ Private slot to show an error message. - @param msg error message to show (string) + @param msg error message to show + @type str """ self.errorGroup.show() self.errors.insertPlainText(msg) @@ -228,10 +235,14 @@ """ Private method to generate a tag item in the taglist. - @param revision revision number (integer) - @param author author of the tag (string) - @param date date of the tag (string) - @param name name (path) of the tag (string) + @param revision revision number + @type int + @param author author of the tag + @type str + @param date date of the tag + @type str + @param name name (path) of the tag + @type str """ itm = QTreeWidgetItem(self.tagList) itm.setData(0, Qt.ItemDataRole.DisplayRole, revision) @@ -244,6 +255,7 @@ """ Public method to get the taglist of the last run. - @return list of tags (list of strings) + @return list of tags + @rtype list of str """ return self.tagsList
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnTagDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnTagDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,11 +22,15 @@ """ Constructor - @param taglist list of previously entered tags (list of strings) - @param reposURL repository path (string) or None + @param taglist list of previously entered tags + @type list of str + @param reposURL repository path or None + @type str @param standardLayout flag indicating the layout of the - repository (boolean) - @param parent parent widget (QWidget) + repository + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -51,7 +55,8 @@ """ Private method used to enable/disable the OK-button. - @param text tag name entered in the combo (string) + @param text tag name entered in the combo + @type str """ self.okButton.setDisabled(text == "") @@ -59,7 +64,8 @@ """ Public method to retrieve the tag data. - @return tuple of string and int (tag, tag operation) + @return tuple containing the tag and tag operation + @rtype tuple of (str, int """ tag = self.tagCombo.currentText() tagOp = 0
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnUrlSelectionDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnUrlSelectionDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -31,10 +31,15 @@ Constructor @param vcs reference to the vcs object - @param tagsList list of tags (list of strings) - @param branchesList list of branches (list of strings) - @param path pathname to determine the repository URL from (string) - @param parent parent widget of the dialog (QWidget) + @type Subversion + @param tagsList list of tags + @type list of str + @param branchesList list of branches + @type list of str + @param path pathname to determine the repository URL from + @type str + @param parent parent widget of the dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -108,8 +113,10 @@ Private method used to change the label combo depending on the selected type. - @param labelCombo reference to the labelCombo object (QComboBox) - @param type_ type string (string) + @param labelCombo reference to the labelCombo object + @type QComboBox + @param type_ type string + @type str """ if type_ == "trunk/": labelCombo.clear() @@ -152,8 +159,8 @@ """ Public method to get the entered URLs. - @return tuple of list of two URL strings (list of strings) and - a flag indicating a diff summary (boolean) + @return tuple of list of two URL strings and a flag indicating a diff summary + @rtype tuple of (list of [str, str], bool) """ if self.vcs.otherData["standardLayout"]: url1 = (
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnUtilities.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnUtilities.py Sat Dec 23 15:40:23 2023 +0100 @@ -21,8 +21,10 @@ """ Module function to return a formatted time string. - @param seconds time in seconds since epoch to be formatted (float or long) - @return formatted time string (string) + @param seconds time in seconds since epoch to be formatted + @type float or int + @return formatted time string + @rtype str """ return ( QDateTime.fromSecsSinceEpoch(int(seconds)) @@ -35,8 +37,10 @@ """ Module function to return the date. - @param seconds time in seconds since epoch to be formatted (float or long) - @return date (QDate) + @param seconds time in seconds since epoch to be formatted + @type float or int + @return date + @rtype QDate """ return ( QDateTime.fromSecsSinceEpoch(int(seconds)) @@ -49,7 +53,8 @@ """ Module function to get the filename of the servers file. - @return filename of the servers file (string) + @return filename of the servers file + @rtype str """ if OSUtilities.isWindowsPlatform(): appdata = os.environ["APPDATA"] @@ -63,7 +68,8 @@ """ Module function to get the filename of the config file. - @return filename of the config file (string) + @return filename of the config file + @rtype str """ if OSUtilities.isWindowsPlatform(): appdata = os.environ["APPDATA"]
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/subversion.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/subversion.py Sat Dec 23 15:40:23 2023 +0100 @@ -45,8 +45,11 @@ Constructor @param plugin reference to the plugin object - @param parent parent widget (QWidget) - @param name name of this object (string) + @type VcsSubversionPlugin + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ VersionControl.__init__(self, parent, name) self.defaultOptions = { @@ -111,7 +114,8 @@ """ Public method to get a reference to the plugin object. - @return reference to the plugin object (VcsPySvnPlugin) + @return reference to the plugin object + @rtype VcsPySvnPlugin """ return self.__plugin @@ -119,7 +123,8 @@ """ Public method to create and initialize the pysvn client object. - @return the pysvn client object (pysvn.Client) + @return the pysvn client object + @rtype pysvn.Client """ configDir = "" authCache = True @@ -166,8 +171,8 @@ """ Public method used to test for the presence of the svn executable. - @return flag indicating the existance (boolean) and an error message - (string) + @return flag indicating the existance and an error message + @rtype tuple of (bool, str) """ self.versionStr = ".".join([str(v) for v in pysvn.svn_version[:-1]]) self.version = pysvn.svn_version[:-1] @@ -181,9 +186,12 @@ because the respective command always works locally. Therefore we always return TRUE without doing anything. - @param vcsDir name of the VCS directory (string) - @param noDialog flag indicating quiet operations (boolean) - @return always TRUE + @param vcsDir name of the VCS directory + @type str + @param noDialog flag indicating quiet operations + @type bool + @return always True + @rtype bool """ return True @@ -262,7 +270,7 @@ @param vcsDataDict dictionary of data required for the import @type dict - @param projectDir project directory (string) + @param projectDir project directory @type str @param noDialog flag indicating quiet operations @type bool @@ -342,9 +350,13 @@ repository. @param vcsDataDict dictionary of data required for the checkout - @param projectDir project directory to create (string) + @type dict + @param projectDir project directory to create + @type str @param noDialog flag indicating quiet operations - @return flag indicating an execution without errors (boolean) + @type bool + @return flag indicating an execution without errors + @rtype bool """ noDialog = False try: @@ -413,8 +425,11 @@ repository. @param vcsDataDict dictionary of data required for the checkout - @param projectDir project directory to create (string) - @return flag indicating an execution without errors (boolean) + @type dict + @param projectDir project directory to create + @type str + @return flag indicating an execution without errors + @rtype bool """ try: tag = vcsDataDict["tag"] @@ -476,10 +491,12 @@ Public method used to make the change of a file/directory permanent in the Subversion repository. - @param name file/directory name to be committed (string or - list of strings) - @param message message for this operation (string) + @param name file/directory name to be committed + @type str or list of str + @param message message for this operation + @type str @param noDialog flag indicating quiet operations + @type bool """ from .SvnCommitDialog import SvnCommitDialog @@ -662,11 +679,12 @@ Public method used to update a file/directory with the Subversion repository. - @param name file/directory name to be updated (string or list of - strings) - @param noDialog flag indicating quiet operations (boolean) - @return flag indicating, that the update contained an add - or delete (boolean) + @param name file/directory name to be updated + @type (str or list of str + @param noDialog flag indicating quiet operations + @type bool + @return flag indicating, that the update contained an add or delete + @rtype bool """ if isinstance(name, list): dname, fnames = self.splitPathList(name) @@ -708,9 +726,12 @@ Public method used to add a file/directory to the Subversion repository. - @param name file/directory name to be added (string) - @param isDir flag indicating name is a directory (boolean) - @param noDialog flag indicating quiet operations (boolean) + @param name file/directory name to be added + @type str + @param isDir flag indicating name is a directory + @type bool + @param noDialog flag indicating quiet operations + @type bool """ if isinstance(name, list): if isDir: @@ -815,8 +836,10 @@ Public method used to add a file/directory in binary mode to the Subversion repository. - @param name file/directory name to be added (string) - @param isDir flag indicating name is a directory (boolean) + @param name file/directory name to be added + @type str + @param isDir flag indicating name is a directory + @type bool """ self.vcsAdd(name, isDir) @@ -825,8 +848,8 @@ Public method to add a directory tree rooted at path to the Subversion repository. - @param path root directory of the tree to be added (string or list of - strings)) + @param path root directory of the tree to be added + @type str or list of str """ tree = [] if isinstance(path, list): @@ -922,12 +945,14 @@ The default operation is to remove the local copy as well. - @param name file/directory name to be removed (string or list of - strings)) - @param project flag indicating deletion of a project tree (boolean) - (not needed) + @param name file/directory name to be removed + @type str or list of str + @param project flag indicating deletion of a project tree + @type bool @param noDialog flag indicating quiet operations - @return flag indicating successfull operation (boolean) + @type bool + @return flag indicating successfull operation + @rtype bool """ if not isinstance(name, list): name = [name] @@ -959,11 +984,16 @@ """ Public method used to move a file/directory. - @param name file/directory name to be moved (string) + @param name file/directory name to be moved + @type str @param project reference to the project object - @param target new name of the file/directory (string) + @type Project + @param target new name of the file/directory + @type str @param noDialog flag indicating quiet operations - @return flag indicating successfull operation (boolean) + @type bool + @return flag indicating successfull operation + @rtype bool """ from .SvnCopyDialog import SvnCopyDialog @@ -1040,7 +1070,8 @@ being edited and has unsaved modification, they can be saved or the operation may be aborted. - @param name file/directory name to be diffed (string) + @param name file/directory name to be diffed + @type str """ from .SvnDiffDialog import SvnDiffDialog @@ -1067,7 +1098,7 @@ Subversion repository. @param name file/directory name(s) to show the status of - (string or list of strings) + @type str or list of str """ from .SvnStatusDialog import SvnStatusDialog @@ -1083,7 +1114,8 @@ Public method used to set the tag of a file/directory in the Subversion repository. - @param name file/directory name to be tagged (string) + @param name file/directory name to be tagged + @type str """ from .SvnTagDialog import SvnTagDialog @@ -1250,9 +1282,10 @@ """ Public method used to switch a directory to a different tag/branch. - @param name directory name to be switched (string) - @return flag indicating, that the switch contained an add - or delete (boolean) + @param name directory name to be switched + @type str + @return flag indicating, that the switch contained an add or delete + @rtype bool """ from .SvnSwitchDialog import SvnSwitchDialog @@ -1336,7 +1369,8 @@ """ Public method used to merge a URL/revision into the local project. - @param name file/directory name to be merged (string) + @param name file/directory name to be merged + @type str """ from .SvnMergeDialog import SvnMergeDialog @@ -1447,8 +1481,10 @@ """ Public method used to get the registered state of a file in the vcs. - @param name filename to check (string) - @return a combination of canBeCommited and canBeAdded + @param name filename to check + @type str + @return registered state (one of canBeCommited and canBeAdded) + @rtype int """ if self.__wcng: return self.__vcsRegisteredState_wcng(name) @@ -1462,8 +1498,10 @@ This is the variant for subversion installations using the new working copy meta-data format. - @param name filename to check (string) - @return a combination of canBeCommited and canBeAdded + @param name filename to check + @type str + @return registered state (one of canBeCommited and canBeAdded) + @rtype int """ if name.endswith(os.sep): name = name[:-1] @@ -1491,8 +1529,10 @@ This is the variant for subversion installations using the old working copy meta-data format. - @param name filename to check (string) - @return a combination of canBeCommited and canBeAdded + @param name filename to check + @type str + @return registered state (one of canBeCommited and canBeAdded) + @rtype int """ dname, fname = self.splitPath(name) @@ -1520,10 +1560,14 @@ that the states for all files has been populated by the previous run. @param names dictionary with all filenames to be checked as keys - @param dname directory to check in (string) - @param shortcut flag indicating a shortcut should be taken (boolean) + @type dict + @param dname directory to check in + @type str + @param shortcut flag indicating a shortcut should be taken + @type bool @return the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error + @rtype dict """ if self.__wcng: return self.__vcsAllRegisteredStates_wcng(names, dname, shortcut) @@ -1543,10 +1587,14 @@ that the states for all files has been populated by the previous run. @param names dictionary with all filenames to be checked as keys - @param dname directory to check in (string) - @param shortcut flag indicating a shortcut should be taken (boolean) + @type dict + @param dname directory to check in + @type str + @param shortcut flag indicating a shortcut should be taken + @type bool @return the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error + @rtype dict """ from .SvnDialogMixin import SvnDialogMixin @@ -1621,10 +1669,14 @@ that the states for all files has been populated by the previous run. @param names dictionary with all filenames to be checked as keys - @param dname directory to check in (string) - @param shortcut flag indicating a shortcut should be taken (boolean) + @type dict + @param dname directory to check in + @type str + @param shortcut flag indicating a shortcut should be taken + @type bool @return the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error + @rtype dict """ from .SvnDialogMixin import SvnDialogMixin @@ -1671,8 +1723,10 @@ Private method to check, if the given status indicates a versioned state. - @param status status object to check (pysvn.PysvnStatus) - @return flag indicating a versioned state (boolean) + @param status status object to check + @type pysvn.PysvnStatus + @return flag indicating a versioned state + @rtype bool """ return status["text_status"] in [ pysvn.wc_status_kind.normal, @@ -1698,7 +1752,8 @@ This method ensures, that eric specific files and directories are ignored. - @param project reference to the project (Project) + @param project reference to the project + @type Project """ configPath = getConfigPath() if os.path.exists(configPath): @@ -1710,7 +1765,8 @@ """ Public method returning the name of the vcs. - @return always 'Subversion' (string) + @return always 'Subversion' + @rtype str """ return "Subversion" @@ -1718,7 +1774,8 @@ """ Public method used to cleanup the working copy. - @param name directory name to be cleaned up (string) + @param name directory name to be cleaned up + @type str """ client = self.getClient() dlg = SvnDialog( @@ -1737,7 +1794,8 @@ """ Public method used to execute arbitrary subversion commands. - @param name directory name of the working directory (string) + @param name directory name of the working directory + @type str """ from eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog import ( SvnDialog as SvnProcessDialog, @@ -1774,11 +1832,15 @@ Public method to get a dialog to enter repository info. @param project reference to the project object - @param archive name of the project in the repository (string) + @type Project + @param archive name of the project in the repository + @type str @param editable flag indicating that the project name is editable - (boolean) - @param parent parent widget (QWidget) - @return reference to the instantiated options dialog (SvnOptionsDialog) + @type bool + @param parent parent widget + @type QWidget + @return reference to the instantiated options dialog + @rtype SvnOptionsDialog """ from .SvnOptionsDialog import SvnOptionsDialog @@ -1789,9 +1851,10 @@ Public method to get a dialog to enter repository info for getting a new project. - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget @return reference to the instantiated options dialog - (SvnNewProjectOptionsDialog) + @rtype SvnNewProjectOptionsDialog """ from .SvnNewProjectOptionsDialog import SvnNewProjectOptionsDialog @@ -1801,8 +1864,10 @@ """ Public method to retrieve information about the repository. - @param ppath local path to get the repository infos (string) - @return string with ready formated info for display (string) + @param ppath local path to get the repository infos + @type str + @return string with ready formated info for display + @rtype str """ try: entry = self.getClient().info(ppath) @@ -1854,8 +1919,10 @@ Public method used to retrieve the URL of the subversion repository path. - @param path local path to get the svn repository path for (string) + @param path local path to get the svn repository path for + @type str @return string with the repository path URL + @rtype str """ client = pysvn.Client() try: @@ -1870,7 +1937,8 @@ """ Public method used to resolve conflicts of a file/directory. - @param name file/directory name to be resolved (string) + @param name file/directory name to be resolved + @type str """ if isinstance(name, list): dname, fnames = self.splitPathList(name) @@ -1906,9 +1974,12 @@ """ Public method used to copy a file/directory. - @param name file/directory name to be copied (string) + @param name file/directory name to be copied + @type str @param project reference to the project object - @return flag indicating successfull operation (boolean) + @type Project + @return flag indicating successfull operation + @rtype bool """ from .SvnCopyDialog import SvnCopyDialog @@ -1957,8 +2028,10 @@ """ Public method used to list the properties of a file/directory. - @param name file/directory name (string or list of strings) + @param name file/directory name + @type str or list of str @param recursive flag indicating a recursive list is requested + @type bool """ from .SvnPropListDialog import SvnPropListDialog @@ -1973,8 +2046,10 @@ """ Public method used to add a property to a file/directory. - @param name file/directory name (string or list of strings) + @param name file/directory name + @type str or list of str @param recursive flag indicating a recursive set is requested + @type bool """ from .SvnPropSetDialog import SvnPropSetDialog @@ -2033,8 +2108,10 @@ """ Public method used to delete a property of a file/directory. - @param name file/directory name (string or list of strings) + @param name file/directory name + @type str or list of str @param recursive flag indicating a recursive list is requested + @type bool """ from .SvnPropDelDialog import SvnPropDelDialog @@ -2089,9 +2166,11 @@ """ Public method used to list the available tags or branches. - @param path directory name of the project (string) + @param path directory name of the project + @type str @param tags flag indicating listing of branches or tags (False = branches, True = tags) + @type bool """ from .SvnTagBranchListDialog import SvnTagBranchListDialog @@ -2119,7 +2198,8 @@ """ Public method to show the output of the svn blame command. - @param name file name to show the blame for (string) + @param name file name to show the blame for + @type str """ from .SvnBlameDialog import SvnBlameDialog @@ -2142,7 +2222,8 @@ This method gives the chance to enter the revisions to be compared. - @param name file/directory name to be diffed (string) + @param name file/directory name to be diffed + @type str """ from .SvnDiffDialog import SvnDiffDialog from .SvnRevisionSelectionDialog import SvnRevisionSelectionDialog @@ -2179,7 +2260,8 @@ This method gives the chance to enter the revisions to be compared. - @param name file/directory name to be diffed (string) + @param name file/directory name to be diffed + @type str """ from .SvnDiffDialog import SvnDiffDialog from .SvnUrlSelectionDialog import SvnUrlSelectionDialog @@ -2212,9 +2294,12 @@ Private method to get a file for a specific revision from the repository. - @param name file name to get from the repository (string) - @param rev revision to retrieve (integer or string) - @return contents of the file (string) and an error message (string) + @param name file name to get from the repository + @type str + @param rev revision to retrieve + @type int or str + @return contents of the file (string) and an error message + @rtype str """ output = "" error = "" @@ -2256,9 +2341,12 @@ Public method used to view the difference of a file to the Mercurial repository side-by-side. - @param name file name to be diffed (string) - @param extended flag indicating the extended variant (boolean) - @param revisions tuple of two revisions (tuple of strings) + @param name file name to be diffed + @type str + @param extended flag indicating the extended variant + @type bool + @param revisions tuple of two revisions + @type tuple of (str, str) @exception ValueError raised to indicate an invalid name parameter type """ from eric7.UI.CompareDialog import CompareDialog @@ -2325,8 +2413,10 @@ Public method used to browse the log of a file/directory from the Subversion repository. - @param name file/directory name to show the log of (string) - @param isFile flag indicating log for a file is to be shown (boolean) + @param name file/directory name to show the log of + @type str + @param isFile flag indicating log for a file is to be shown + @type bool """ from .SvnLogBrowserDialog import SvnLogBrowserDialog @@ -2341,11 +2431,12 @@ """ Public method used to lock a file in the Subversion repository. - @param name file/directory name to be locked (string or list of - strings) - @param stealIt flag indicating a forced operation (boolean) + @param name file/directory name to be locked + @type str or list of str + @param stealIt flag indicating a forced operation + @type bool @param parent reference to the parent object of the subversion dialog - (QWidget) + @type QWidget """ comment, ok = QInputDialog.getText( None, @@ -2392,11 +2483,12 @@ """ Public method used to unlock a file in the Subversion repository. - @param name file/directory name to be unlocked (string or list of - strings) - @param breakIt flag indicating a forced operation (boolean) + @param name file/directory name to be unlocked + @type str or list of str + @param breakIt flag indicating a forced operation + @type bool @param parent reference to the parent object of the subversion dialog - (QWidget) + @type QWidget """ if isinstance(name, list): dname, fnames = self.splitPathList(name) @@ -2429,8 +2521,10 @@ """ Public method to show repository information about a file or directory. - @param projectPath path name of the project (string) - @param name file/directory name relative to the project (string) + @param projectPath path name of the project + @type str + @param name file/directory name relative to the project + @type str """ from .SvnInfoDialog import SvnInfoDialog @@ -2442,7 +2536,8 @@ """ Public method to relocate the working copy to a new repository URL. - @param projectPath path name of the project (string) + @param projectPath path name of the project + @type str """ from .SvnRelocateDialog import SvnRelocateDialog @@ -2472,7 +2567,8 @@ """ Public method to open the repository browser. - @param projectPath path name of the project (string) + @param projectPath path name of the project + @type str """ from .SvnRepoBrowserDialog import SvnRepoBrowserDialog @@ -2500,7 +2596,7 @@ Note: Directories will be removed recursively. @param names name or list of names of file or directory to remove - (string) + @type str or list of str """ if not isinstance(names, list): names = [names] @@ -2527,7 +2623,7 @@ Note: Directories will be added recursively. @param names name or list of names of file or directory to add - (string) + @type str or list of str """ if not isinstance(names, list): names = [names] @@ -2563,7 +2659,8 @@ """ Public method used to inspect the change lists defined for the project. - @param path directory name to show change lists for (string) + @param path directory name to show change lists for + @type str """ from .SvnChangeListsDialog import SvnChangeListsDialog @@ -2576,7 +2673,8 @@ """ Public method to get a list of all defined change lists. - @return list of defined change list names (list of strings) + @return list of defined change list names + @rtype list of str """ changelists = [] client = self.getClient() @@ -2596,7 +2694,8 @@ """ Public method to upgrade the working copy format. - @param path directory name to show change lists for (string) + @param path directory name to show change lists for + @type str """ client = self.getClient() dlg = SvnDialog(self.tr("Upgrade"), "upgrade {0}".format(path), client) @@ -2617,8 +2716,10 @@ """ Private method to format a url for subversion. - @param url unformatted url string (string) - @return properly formated url for subversion (string) + @param url unformatted url string + @type str + @return properly formated url for subversion + @rtype str """ url = self.svnNormalizeURL(url) url = url.split(":", 2) @@ -2643,8 +2744,10 @@ """ Public method to normalize a url for subversion. - @param url url string (string) - @return properly normalized url for subversion (string) + @param url url string + @type str + @return properly normalized url for subversion + @rtype str """ protocol, url = url.split("://", 1) if url.startswith("\\\\"): @@ -2670,10 +2773,14 @@ project browsers. @param browser reference to the project browser object + @type ProjectBaseBrowser @param project reference to the project object + @type Project @param isTranslationsBrowser flag indicating, the helper is requested for the translations browser (this needs some special treatment) + @type bool @return the project browser helper object + @rtype SvnProjectBrowserHelper """ from .ProjectBrowserHelper import SvnProjectBrowserHelper @@ -2684,7 +2791,9 @@ Public method to instanciate a helper object for the project. @param project reference to the project object + @type Project @return the project helper object + @rtype PySvnProjectHelper """ helper = self.__plugin.getProjectHelper() helper.setObjects(self, project) @@ -2706,9 +2815,11 @@ thread. @param interval check interval for the monitor thread in seconds - (integer) + @type int @param project reference to the project object - @return reference to the monitor thread (QThread) + @type Project + @return reference to the monitor thread + @rtype SvnStatusMonitorThread """ from .SvnStatusMonitorThread import SvnStatusMonitorThread
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/ConfigurationPage/SubversionPage.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/ConfigurationPage/SubversionPage.py Sat Dec 23 15:40:23 2023 +0100 @@ -26,6 +26,7 @@ Constructor @param plugin reference to the plugin object + @type VcsSubversionPlugin """ super().__init__() self.setupUi(self)
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/ProjectBrowserHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/ProjectBrowserHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -35,12 +35,18 @@ Constructor @param vcsObject reference to the vcs object + @type Subversion @param browserObject reference to the project browser object + @type ProjectBaseBrowser @param projectObject reference to the project object + @type Project @param isTranslationsBrowser flag indicating, the helper is requested for the translations browser (this needs some special treatment) - @param parent parent widget (QWidget) - @param name name of this object (string) + @type bool + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ VcsProjectBrowserHelper.__init__( self, @@ -60,8 +66,10 @@ VCS status and the file status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ if self.browser.currentItem().data(1) == self.vcs.vcsName(): for act in self.vcsMenuActions: @@ -96,8 +104,10 @@ VCS status and the files status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ vcsName = self.vcs.vcsName() items = self.browser.getSelectedItems() @@ -136,8 +146,10 @@ VCS status and the directory status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ if self.browser.currentItem().data(1) == self.vcs.vcsName(): for act in self.vcsDirMenuActions: @@ -162,8 +174,10 @@ VCS status and the directory status. @param menu reference to the menu to be shown + @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status + @type list of QAction """ vcsName = self.vcs.vcsName() items = self.browser.getSelectedItems() @@ -201,6 +215,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ self.vcsMenuActions = [] self.vcsAddMenuActions = [] @@ -387,6 +402,7 @@ project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ self.vcsMultiMenuActions = [] self.vcsAddMultiMenuActions = [] @@ -540,6 +556,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return @@ -584,6 +601,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return @@ -727,6 +745,7 @@ Protected method used to add the VCS menu to all project browsers. @param mainMenu reference to the menu to be amended + @type QMenu """ if mainMenu is None: return @@ -1088,7 +1107,9 @@ """ Private method to check, if items contain file type items. - @param items items to check (list of QTreeWidgetItems) - @return flag indicating items contain file type items (boolean) + @param items items to check + @type list of QTreeWidgetItems + @return flag indicating items contain file type items + @rtype bool """ return any(isinstance(itm, ProjectBrowserFileItem) for itm in items)
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/ProjectHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/ProjectHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -27,9 +27,13 @@ Constructor @param vcsObject reference to the vcs object + @type Subversion @param projectObject reference to the project object - @param parent parent widget (QWidget) - @param name name of this object (string) + @type Project + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ VcsProjectHelper.__init__(self, vcsObject, projectObject, parent, name) @@ -37,7 +41,8 @@ """ Public method to get a list of all actions. - @return list of all actions (list of EricAction) + @return list of all actions + @rtype list of EricAction """ return self.actions[:] @@ -605,7 +610,8 @@ """ Public method to generate the VCS menu. - @param menu reference to the menu to be populated (QMenu) + @param menu reference to the menu to be populated + @type QMenu """ menu.clear() @@ -668,9 +674,10 @@ """ Public slot to initialize the VCS toolbar. - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ self.__toolbar = QToolBar(self.tr("Subversion (svn)"), ui) self.__toolbar.setObjectName("SubversionToolbar") @@ -711,9 +718,10 @@ """ Public method to remove a toolbar created by initToolbar(). - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ ui.removeToolBar(self.__toolbar) ui.unregisterToolbar("subversion")
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnBlameDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnBlameDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -35,7 +35,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -61,7 +63,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.process is not None @@ -77,7 +80,8 @@ """ Public slot to start the svn blame command. - @param fn filename to show the blame for (string) + @param fn filename to show the blame for + @type str """ self.blameList.clear() self.errorGroup.hide() @@ -142,7 +146,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -154,8 +159,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__finish() @@ -169,9 +176,12 @@ """ Private method to generate a blame item in the blame list. - @param revision revision string (string) - @param author author of the change (string) - @param text line of text from the annotated file (string) + @param revision revision string + @type str + @param author author of the change + @type str + @param text line of text from the annotated file + @type str """ itm = QTreeWidgetItem( self.blameList, [revision, author, "{0:d}".format(self.lineno), text] @@ -220,7 +230,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -258,7 +269,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnChangeListsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnChangeListsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -30,7 +30,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -61,8 +63,10 @@ """ Private slot to handle the selection of a new item. - @param current current item (QListWidgetItem) - @param previous previous current item (QListWidgetItem) + @param current current item + @type QListWidgetItem + @param previous previous current item + @type QListWidgetItem """ self.filesList.clear() if current is not None: @@ -74,7 +78,8 @@ """ Public slot to populate the data. - @param path directory name to show change lists for (string) + @param path directory name to show change lists for + @type str """ self.changeListsDict = {} @@ -142,7 +147,7 @@ self.inputGroup.hide() if len(self.changeListsDict) == 0: - self.changeLists.addItem(self.tr("No changelists found")) + self.changeLists.addItem(self.tr("No change lists found")) self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setFocus( Qt.FocusReason.OtherFocusReason ) @@ -155,7 +160,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -167,8 +173,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__finish() @@ -232,7 +240,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -270,7 +279,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnCommandDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnCommandDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -29,10 +29,14 @@ """ Constructor - @param argvList history list of commandline arguments (list of strings) - @param wdList history list of working directories (list of strings) - @param ppath pathname of the project directory (string) - @param parent parent widget of this dialog (QWidget) + @param argvList history list of commandline arguments + @type list of str + @param wdList history list of working directories + @type list of str + @param ppath pathname of the project directory + @type str + @param parent parent widget of this dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -69,7 +73,8 @@ """ Private method used to enable/disable the OK-button. - @param text ignored + @param text text of the command combobox + @type str """ self.okButton.setDisabled(self.commandCombo.currentText() == "") @@ -77,6 +82,7 @@ """ Public method to retrieve the data entered into this dialog. - @return a tuple of argv, workdir + @return tuple cotaining the command line arguments and the working directory + @rtype tuple of (str, str) """ return (self.commandCombo.currentText(), self.workdirPicker.currentText())
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnCommitDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnCommitDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -31,7 +31,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent, Qt.WindowType.Window) self.setupUi(self) @@ -52,7 +54,8 @@ """ Protected method called when the dialog is about to be shown. - @param evt the event (QShowEvent) + @param evt the event + @type QShowEvent """ commitMessages = self.__vcs.vcsCommitMessages() self.recentComboBox.clear() @@ -65,7 +68,8 @@ """ Public method to retrieve the log message. - @return the log message (string) + @return the log message + @rtype str """ msg = self.logEdit.toPlainText() if msg: @@ -74,18 +78,20 @@ def hasChangelists(self): """ - Public method to check, if the user entered some changelists. + Public method to check, if the user entered some change lists. - @return flag indicating availability of changelists (boolean) + @return flag indicating availability of change lists + @rtype bool """ return len(self.changeLists.selectedItems()) > 0 def changelistsData(self): """ - Public method to retrieve the changelists data. + Public method to retrieve the change lists data. - @return tuple containing the changelists (list of strings) and a flag - indicating to keep changelists (boolean) + @return tuple containing the change lists and a flag indicating to keep + the change lists + @rtype tuple of (list of str, bool) """ slists = [ line.text().strip() @@ -102,7 +108,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel): self.logEdit.clear()
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnCopyDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnCopyDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -27,10 +27,14 @@ """ Constructor - @param source name of the source file/directory (string) - @param parent parent widget (QWidget) - @param move flag indicating a move operation (boolean) - @param force flag indicating a forced operation (boolean) + @param source name of the source file/directory + @type str + @param parent parent widget + @type QWidget + @param move flag indicating a move operation + @type bool + @param force flag indicating a forced operation + @type bool """ super().__init__(parent) self.setupUi(self) @@ -58,8 +62,9 @@ """ Public method to retrieve the copy data. - @return the target name (string) and a flag indicating - the operation should be enforced (boolean) + @return tuple containing the target name and a flag indicating the + operation should be enforced + @rtype tuple of (str, bool) """ target = self.targetPicker.text() if not os.path.isabs(target): @@ -72,7 +77,8 @@ """ Private slot to handle changes of the target. - @param txt contents of the target edit (string) + @param txt contents of the target edit + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( os.path.isabs(txt) or os.path.dirname(txt) == ""
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -32,8 +32,10 @@ """ Constructor - @param text text to be shown by the label (string) - @param parent parent widget (QWidget) + @param text text to be shown by the label + @type str + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -88,7 +90,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -99,8 +102,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.normal = exitStatus == QProcess.ExitStatus.NormalExit and exitCode == 0 self.__finish() @@ -109,10 +114,14 @@ """ Public slot used to start the process. - @param args list of arguments for the process (list of strings) - @param workingDir working directory for the process (string) - @param setLanguage flag indicating to set the language to "C" (boolean) + @param args list of arguments for the process + @type list of str + @param workingDir working directory for the process + @type str + @param setLanguage flag indicating to set the language to "C" + @type bool @return flag indicating a successful start of the process + @rtype bool """ self.errorGroup.hide() self.normal = False @@ -168,7 +177,8 @@ """ Public method to check for a normal process termination. - @return flag indicating normal process termination (boolean) + @return flag indicating normal process termination + @rtype bool """ return self.normal @@ -218,7 +228,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -256,7 +267,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False @@ -268,6 +280,7 @@ """ Public method to check, if the last action contained an add or delete. - @return flag indicating the presence of an add or delete (boolean) + @return flag indicating the presence of an add or delete + @rtype bool """ return self.__hasAddOrDelete
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnDiffDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnDiffDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -35,7 +35,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -66,7 +68,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.process is not None @@ -82,8 +85,10 @@ """ Private method to get a svn revision argument for the given revision. - @param version revision (integer or string) - @return version argument (string) + @param version revision + @type int or str + @return version argument + @rtype str """ if version == "WORKING": return None @@ -94,13 +99,17 @@ """ Public slot to start the svn diff command. - @param fn filename to be diffed (string) - @param versions list of versions to be diffed (list of up to 2 strings - or None) - @param urls list of repository URLs (list of 2 strings) + @param fn filename to be diffed + @type str + @param versions list of versions to be diffed + @type list of up to 2 str or None + @param urls list of repository URLs + @type list of [str, str] @param summary flag indicating a summarizing diff - (only valid for URL diffs) (boolean) - @param refreshable flag indicating a refreshable diff (boolean) + (only valid for URL diffs) + @type bool + @param refreshable flag indicating a refreshable diff + @type bool """ self.refreshButton.setVisible(refreshable) @@ -197,8 +206,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.inputGroup.setEnabled(False) self.inputGroup.hide() @@ -233,7 +244,8 @@ """ Private method to append text to the end of the contents pane. - @param txt text to insert (string) + @param txt text to insert + @type str """ tc = self.contents.textCursor() tc.movePosition(QTextCursor.MoveOperation.End) @@ -244,8 +256,10 @@ """ Private method to extract the file name out of a file separator line. - @param line line to be processed (string) - @return extracted file name (string) + @param line line to be processed + @type str + @return extracted file name + @rtype str """ f = line.split(None, 1)[1] f = f.rsplit(None, 2)[0] @@ -255,7 +269,8 @@ """ Private slot to process a line giving the old/new file. - @param line line to be processed (string) + @param line line to be processed + @type str """ if line.startswith("---"): self.__oldFileLine = self.paras @@ -308,7 +323,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Save): self.on_saveButton_clicked() @@ -320,7 +336,8 @@ """ Private slot to handle the selection of a file. - @param index activated row (integer) + @param index activated row + @type int """ para = self.filesCombo.itemData(index) @@ -431,7 +448,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -469,7 +487,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnDiffHighlighter.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnDiffHighlighter.py Sat Dec 23 15:40:23 2023 +0100 @@ -22,7 +22,8 @@ """ Constructor - @param doc reference to the text document (QTextDocument) + @param doc reference to the text document + @type QTextDocument """ super().__init__(doc)
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnLogBrowserDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnLogBrowserDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -39,7 +39,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -134,7 +136,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.__process is not None @@ -211,13 +214,19 @@ """ Private method to generate a log tree entry. - @param author author info (string) - @param date date info (string) - @param message text of the log message (list of strings) - @param revision revision info (string) + @param author author info + @type str + @param date date info + @type str + @param message text of the log message + @type list of str + @param revision revision info + @type str @param changedPaths list of dictionary objects containing info about the changed files/directories - @return reference to the generated item (QTreeWidgetItem) + @type dict + @return reference to the generated item + @rtype QTreeWidgetItem """ msg = [] for line in message: @@ -250,10 +259,15 @@ Private method to generate a changed files tree entry. @param action indicator for the change action ("A", "D" or "M") - @param path path of the file in the repository (string) - @param copyFrom path the file was copied from (None, string) - @param copyRev revision the file was copied from (None, string) - @return reference to the generated item (QTreeWidgetItem) + @type str + @param path path of the file in the repository + @type str + @param copyFrom path the file was copied from + @type str + @param copyRev revision the file was copied from + @type str + @return reference to the generated item + @rtype QTreeWidgetItem """ itm = QTreeWidgetItem( self.filesTree, @@ -273,7 +287,8 @@ """ Private method to retrieve log entries from the repository. - @param startRev revision number to start from (integer, string) + @param startRev revision number to start from + @type int or str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setEnabled(False) self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel).setEnabled(True) @@ -324,9 +339,10 @@ """ Public slot to start the svn log command. - @param fn filename to show the log for (string) + @param fn filename to show the log for + @type str @param isFile flag indicating log for a file is to be shown - (boolean) + @type bool """ self.sbsCheckBox.setEnabled(isFile) self.sbsCheckBox.setVisible(isFile) @@ -351,8 +367,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__processBuffer() self.__finish() @@ -510,8 +528,10 @@ """ Private method to do a diff of two revisions. - @param rev1 first revision number (integer) - @param rev2 second revision number (integer) + @param rev1 first revision number + @type int + @param rev2 second revision number + @type int """ from .SvnDiffDialog import SvnDiffDialog @@ -528,7 +548,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -541,8 +562,10 @@ """ Private slot called, when the current item of the log tree changes. - @param current reference to the new current item (QTreeWidgetItem) - @param previous reference to the old current item (QTreeWidgetItem) + @param current reference to the new current item + @type QTreeWidgetItem + @param previous reference to the old current item + @type QTreeWidgetItem """ if current is not None: self.messageEdit.clear() @@ -631,7 +654,8 @@ """ Private slot called, when the from date changes. - @param date new date (QDate) + @param date new date + @type QDate """ self.__filterLogs() @@ -640,7 +664,8 @@ """ Private slot called, when the from date changes. - @param date new date (QDate) + @param date new date + @type QDate """ self.__filterLogs() @@ -659,7 +684,8 @@ """ Private slot called, when a filter expression is entered. - @param txt filter expression (string) + @param txt filter expression + @type str """ self.__filterLogs() @@ -707,7 +733,8 @@ """ Private slot called, when the stop on copy/move checkbox is clicked. - @param checked flag indicating the checked state (boolean) + @param checked flag indicating the checked state + @type bool """ self.vcs.getPlugin().setPreferences( "StopLogOnCopy", self.stopCheckBox.isChecked() @@ -741,7 +768,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -780,7 +808,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnMergeDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnMergeDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -25,12 +25,15 @@ Constructor @param mergelist1 list of previously entered URLs/revisions - (list of strings) + @type list of str @param mergelist2 list of previously entered URLs/revisions - (list of strings) - @param targetlist list of previously entered targets (list of strings) - @param force flag indicating a forced merge (boolean) - @param parent parent widget (QWidget) + @type list of str + @param targetlist list of previously entered targets + @type list of str + @param force flag indicating a forced merge + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -77,7 +80,8 @@ """ Private slot to handle the tag1Combo editTextChanged signal. - @param text text of the combo (string) + @param text text of the combo + @type str """ self.__enableOkButton() @@ -86,7 +90,8 @@ """ Private slot to handle the tag2Combo editTextChanged signal. - @param text text of the combo (string) + @param text text of the combo + @type str """ self.__enableOkButton() @@ -95,7 +100,8 @@ Public method to retrieve the merge data. @return tuple naming two tag names or two revisions, a target and - a flag indicating a forced merge (string, string, string, boolean) + a flag indicating a forced merge + @rtype tuple of (str, str, str, bool) """ return ( self.tag1Combo.currentText(),
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnNewProjectOptionsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnNewProjectOptionsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -32,7 +32,9 @@ Constructor @param vcs reference to the version control object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -71,7 +73,8 @@ """ Private slot to handle a change of the project directory. - @param txt name of the project directory (string) + @param txt name of the project directory + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( bool(txt) @@ -100,7 +103,8 @@ """ Private slot to handle the change of the layout checkbox. - @param checked flag indicating the state of the checkbox (boolean) + @param checked flag indicating the state of the checkbox + @type bool """ self.vcsTagLabel.setEnabled(checked) self.vcsTagEdit.setEnabled(checked) @@ -135,7 +139,8 @@ """ Private slot to handle changes of the URL. - @param txt current text of the line edit (string) + @param txt current text of the line edit + @type str """ enable = "://" not in txt self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled(enable) @@ -144,8 +149,9 @@ """ Public slot to retrieve the data entered into the dialog. - @return a tuple of a string (project directory) and a dictionary - containing the data entered. + @return tuple containing the (project directory and a dictionary containing + the data entered. + @rtype tuple of (str, dict) """ scheme = self.protocolCombo.currentText() url = self.vcsUrlPicker.text()
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnOptionsDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnOptionsDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -31,8 +31,11 @@ Constructor @param vcs reference to the version control object + @type Subversion @param project reference to the project object - @param parent parent widget (QWidget) + @type Project + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -101,7 +104,8 @@ """ Private slot to handle changes of the URL. - @param txt current text of the line edit (string) + @param txt current text of the line edit + @type str """ enable = "://" not in txt self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled(enable) @@ -111,6 +115,7 @@ Public slot to retrieve the data entered into the dialog. @return a dictionary containing the data entered + @rtype dict """ scheme = self.protocolCombo.currentText() url = self.vcsUrlPicker.text()
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnPropListDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnPropListDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -30,7 +30,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -80,9 +82,12 @@ """ Private method to generate a properties item in the properties list. - @param path file/directory name the property applies to (string) - @param propName name of the property (string) - @param propValue value of the property (string) + @param path file/directory name the property applies to + @type str + @param propName name of the property + @type str + @param propValue value of the property + @type str """ QTreeWidgetItem(self.propsList, [path, propName, propValue.strip()]) @@ -90,7 +95,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.process is not None @@ -106,8 +112,10 @@ """ Public slot to start the svn status command. - @param fn filename(s) (string or list of string) + @param fn filename(s) + @type str or list of str @param recursive flag indicating a recursive list is requested + @type bool """ self.errorGroup.hide() @@ -182,7 +190,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -203,8 +212,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ if self.lastPath is None: self.__generateItem("", "None", "")
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnPropSetDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnPropSetDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,7 +23,8 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -34,9 +35,9 @@ """ Public slot used to retrieve the data entered into the dialog. - @return tuple of three values giving the property name, a flag - indicating a file was selected and the text of the property - or the selected filename. (string, boolean, string) + @return tuple containing the property name, a flag indicating a file was + selected and the text of the property or the selected filename + @rtype tuple of (str, bool, str) """ if self.fileRadioButton.isChecked(): return (self.propNameEdit.text(), True, self.propFilePicker.text())
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnRelocateDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnRelocateDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -21,8 +21,10 @@ """ Constructor - @param currUrl current repository URL (string) - @param parent parent widget (QWidget) + @param currUrl current repository URL + @type str + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -37,7 +39,8 @@ """ Public slot used to retrieve the data entered into the dialog. - @return the new repository URL (string) and an indication, if - the relocate is inside the repository (boolean) + @return the new repository URL and an indication, if the relocate is inside + the repository + @rtype tuple of (str, bool) """ return self.newUrlEdit.text(), self.insideCheckBox.isChecked()
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnRepoBrowserDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnRepoBrowserDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -38,8 +38,11 @@ Constructor @param vcs reference to the vcs object - @param mode mode of the dialog (string, "browse" or "select") - @param parent parent widget (QWidget) + @type Subversion + @param mode mode of the dialog ("browse" or "select") + @type str + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -83,7 +86,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.__process is not None @@ -114,14 +118,22 @@ """ Private method to generate a tree item in the repository tree. - @param repopath path of the item (string) - @param revision revision info (string) - @param author author info (string) - @param size size info (string) - @param date date info (string) - @param nodekind node kind info (string, "dir" or "file") - @param url url of the entry (string) - @return reference to the generated item (QTreeWidgetItem) + @param repopath path of the item + @type str + @param revision revision info + @type str + @param author author info + @type str + @param size size info + @type str + @param date date info + @type str + @param nodekind node kind info ("dir" or "file") + @type str + @param url url of the entry + @type str + @return reference to the generated item + @rtype QTreeWidgetItem """ rev = "" if revision == "" else int(revision) sz = "" if size == "" else int(size) @@ -155,8 +167,10 @@ """ Private method to get the repository root using the svn info command. - @param url the repository URL to browser (string) - @return repository root (string) + @param url the repository URL to browser + @type str + @return repository root + @rtype str """ ioEncoding = Preferences.getSystem("IOEncoding") repoRoot = None @@ -204,9 +218,10 @@ """ Private method to perform the svn list command. - @param url the repository URL to browse (string) + @param url the repository URL to browse + @type str @param parent reference to the item, the data should be appended to - (QTreeWidget or QTreeWidgetItem) + @type QTreeWidget or QTreeWidgetItem """ self.errorGroup.hide() @@ -271,8 +286,10 @@ """ Private method to normalite the url. - @param url the url to normalize (string) - @return normalized URL (string) + @param url the url to normalize + @type str + @return normalized URL + @rtype str """ if url.endswith("/"): return url[:-1] @@ -282,7 +299,8 @@ """ Public slot to start the svn info command. - @param url the repository URL to browser (string) + @param url the repository URL to browser + @type str """ self.repoTree.clear() @@ -312,7 +330,8 @@ """ Private slot called when an item is expanded. - @param item reference to the item to be expanded (QTreeWidgetItem) + @param item reference to the item to be expanded + @type QTreeWidgetItem """ if not self.__ignoreExpand: url = item.data(0, self.__urlRole) @@ -323,7 +342,8 @@ """ Private slot called when an item is collapsed. - @param item reference to the item to be collapsed (QTreeWidgetItem) + @param item reference to the item to be collapsed + @type QTreeWidgetItem """ for child in item.takeChildren(): del child @@ -349,7 +369,8 @@ """ Public method to retrieve the selected repository URL. - @return the selected repository URL (string) + @return the selected repository URL + @rtype str """ items = self.repoTree.selectedItems() if len(items) == 1: @@ -381,8 +402,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__finish() @@ -448,7 +471,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -486,7 +510,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnRevisionSelectionDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnRevisionSelectionDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -23,7 +23,8 @@ """ Constructor - @param parent parent widget of the dialog (QWidget) + @param parent parent widget of the dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -39,7 +40,9 @@ Private method to generate the revision. @param no revision number to generate (1 or 2) - @return revision (integer or string) + @type int + @return revision + @rtype int or str """ if no == 1: numberButton = self.number1Button @@ -89,7 +92,8 @@ """ Public method to get the revisions. - @return list two integers or strings + @return list containing two revisions + @rtype list of [int or str, int or str] """ rev1 = self.__getRevision(1) rev2 = self.__getRevision(2)
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnStatusDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnStatusDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -41,7 +41,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -266,17 +268,28 @@ """ Private method to generate a status item in the status list. - @param status status indicator (string) - @param propStatus property status indicator (string) - @param locked locked indicator (string) - @param history history indicator (string) - @param switched switched indicator (string) - @param lockinfo lock indicator (string) - @param uptodate up to date indicator (string) - @param revision revision string (string) - @param change revision of last change (string) - @param author author of the last change (string) - @param path path of the file or directory (string) + @param status status indicator + @type str + @param propStatus property status indicator + @type str + @param locked locked indicator + @type str + @param history history indicator + @type str + @param switched switched indicator + @type str + @param lockinfo lock indicator + @type str + @param uptodate up to date indicator + @type str + @param revision revision string + @type str + @param change revision of last change + @type str + @param author author of the last change + @type str + @param path path of the file or directory + @type str """ if ( self.__nonverbose @@ -358,7 +371,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.process is not None @@ -375,7 +389,7 @@ Public slot to start the svn status command. @param fn filename(s)/directoryname(s) to show the status of - (string or list of strings) + @type str or list of str """ self.errorGroup.hide() self.intercept = False @@ -516,7 +530,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -530,8 +545,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__finish() @@ -619,7 +636,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -657,7 +675,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False @@ -716,8 +735,10 @@ """ Private slot to act upon item changes. - @param item reference to the changed item (QTreeWidgetItem) - @param column index of column that changed (integer) + @param item reference to the changed item + @type QTreeWidgetItem + @param column index of column that changed + @type int """ if column == self.__toBeCommittedColumn: self.__updateCommitButton() @@ -779,7 +800,8 @@ """ Private slot to show the context menu of the status list. - @param coord the position of the mouse pointer (QPoint) + @param coord the position of the mouse pointer + @type QPoint """ self.menu.popup(self.statusList.mapToGlobal(coord)) @@ -1046,7 +1068,7 @@ def __removeFromChangelist(self): """ - Private slot to remove entries from their changelists. + Private slot to remove entries from their change lists. """ names = [ os.path.join(self.dname, itm.text(self.__pathColumn)) @@ -1070,6 +1092,7 @@ Private method to retrieve all entries the user wants to commit. @return list of all items, the user has checked + @rtype list of QTreeWidgetItem """ commitableItems = [] for index in range(self.statusList.topLevelItemCount()): @@ -1083,6 +1106,7 @@ Private method to retrieve all entries, that have a modified status. @return list of all items with a modified status + @rtype list of QTreeWidgetItem """ modifiedItems = [] for itm in self.statusList.selectedItems(): @@ -1099,6 +1123,7 @@ status. @return list of all items with an unversioned status + @rtype list of QTreeWidgetItem """ unversionedItems = [] for itm in self.statusList.selectedItems(): @@ -1111,6 +1136,7 @@ Private method to retrieve all entries, that have a missing status. @return list of all items with a missing status + @rtype list of QTreeWidgetItem """ missingItems = [] for itm in self.statusList.selectedItems(): @@ -1122,8 +1148,10 @@ """ Private method to retrieve all emtries, that have a locked status. - @param indicators list of indicators to check against (list of strings) + @param indicators list of indicators to check against + @type list of str @return list of all items with a locked status + @rtype list of QTreeWidgetItem """ lockitems = [] for itm in self.statusList.selectedItems(): @@ -1137,6 +1165,7 @@ a changelist. @return list of all items belonging to a changelist + @rtype list of QTreeWidgetItem """ clitems = [] for itm in self.statusList.selectedItems(): @@ -1150,6 +1179,7 @@ a changelist. @return list of all items not belonging to a changelist + @rtype list of QTreeWidgetItem """ clitems = [] for itm in self.statusList.selectedItems(): @@ -1161,7 +1191,8 @@ """ Private slot to select or deselect all entries. - @param selected commit selection state to be set (boolean) + @param selected commit selection state to be set + @type bool """ for index in range(self.statusList.topLevelItemCount()): itm = self.statusList.topLevelItem(index)
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnStatusMonitorThread.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnStatusMonitorThread.py Sat Dec 23 15:40:23 2023 +0100 @@ -24,10 +24,14 @@ """ Constructor - @param interval new interval in seconds (integer) - @param project reference to the project object (Project) + @param interval new interval in seconds + @type int + @param project reference to the project object + @type Project @param vcs reference to the version control object - @param parent reference to the parent object (QObject) + @type Subversion + @param parent reference to the parent object + @type QObject """ VcsStatusMonitorThread.__init__(self, interval, project, vcs, parent) @@ -58,8 +62,9 @@ <li>" " path is back at normal</li> </ul> - @return tuple of flag indicating successful operation (boolean) and - a status message in case of non successful operation (string) + @return tuple of flag indicating successful operation and a status message + in case of non successful operation + @rtype tuple of (bool, str) """ self.shouldUpdate = False
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnSwitchDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnSwitchDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -21,11 +21,14 @@ """ Constructor - @param taglist list of previously entered tags (list of strings) - @param reposURL repository path (string) or None - @param standardLayout flag indicating the layout of the - repository (boolean) - @param parent parent widget (QWidget) + @param taglist list of previously entered tags + @type list of str + @param reposURL repository path or None + @type str + @param standardLayout flag indicating the layout of the repository + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -46,7 +49,8 @@ """ Public method to retrieve the tag data. - @return tuple of string and int (tag, tag type) + @return tuple containing the tag and tag type) + @rtype tuple of (str, int) """ tag = self.tagCombo.currentText() tagType = 0
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnTagBranchListDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnTagBranchListDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -37,7 +37,9 @@ Constructor @param vcs reference to the vcs object - @param parent parent widget (QWidget) + @type Subversion + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -67,7 +69,8 @@ """ Protected slot implementing a close event handler. - @param e close event (QCloseEvent) + @param e close event + @type QCloseEvent """ if ( self.process is not None @@ -83,12 +86,15 @@ """ Public slot to start the svn status command. - @param path name of directory to be listed (string) + @param path name of directory to be listed + @type str @param tags flag indicating a list of tags is requested (False = branches, True = tags) + @type bool @param tagsList reference to string list receiving the tags - (list of strings) - @param allTagsList reference to string list all tags (list of strings) + @type list of str + @param allTagsList reference to string list all tags + @type list of str """ self.errorGroup.hide() @@ -218,7 +224,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.close() @@ -230,8 +237,10 @@ """ Private slot connected to the finished signal. - @param exitCode exit code of the process (integer) - @param exitStatus exit status of the process (QProcess.ExitStatus) + @param exitCode exit code of the process + @type int + @param exitStatus exit status of the process + @type QProcess.ExitStatus """ self.__finish() @@ -254,10 +263,14 @@ """ Private method to generate a tag item in the taglist. - @param revision revision string (string) - @param author author of the tag (string) - @param date date of the tag (string) - @param name name (path) of the tag (string) + @param revision revision string + @type str + @param author author of the tag + @type str + @param date date of the tag + @type str + @param name name (path) of the tag + @type str """ itm = QTreeWidgetItem(self.tagList) itm.setData(0, Qt.ItemDataRole.DisplayRole, int(revision)) @@ -316,7 +329,8 @@ """ Private slot to handle the password checkbox toggled. - @param isOn flag indicating the status of the check box (boolean) + @param isOn flag indicating the status of the check box + @type bool """ if isOn: self.input.setEchoMode(QLineEdit.EchoMode.Password) @@ -354,7 +368,8 @@ """ Protected slot to handle a key press event. - @param evt the key press event (QKeyEvent) + @param evt the key press event + @type QKeyEvent """ if self.intercept: self.intercept = False
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnTagDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnTagDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -21,11 +21,15 @@ """ Constructor - @param taglist list of previously entered tags (list of strings) - @param reposURL repository path (string) or None + @param taglist list of previously entered tags + @type list of str + @param reposURL repository path or None + @type str @param standardLayout flag indicating the layout of the - repository (boolean) - @param parent parent widget (QWidget) + repository + @type bool + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -49,7 +53,8 @@ """ Private method used to enable/disable the OK-button. - @param text text of the tag combobox (string) + @param text text of the tag combobox + @type str """ self.okButton.setDisabled(text == "") @@ -57,7 +62,8 @@ """ Public method to retrieve the tag data. - @return tuple of string and int (tag, tag operation) + @return tuple containing the tag and tag operation + @rtype tuple of (str, int) """ tag = self.tagCombo.currentText() tagOp = 0
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnUrlSelectionDialog.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnUrlSelectionDialog.py Sat Dec 23 15:40:23 2023 +0100 @@ -29,10 +29,15 @@ Constructor @param vcs reference to the vcs object - @param tagsList list of tags (list of strings) - @param branchesList list of branches (list of strings) - @param path pathname to determine the repository URL from (string) - @param parent parent widget of the dialog (QWidget) + @type Subversion + @param tagsList list of tags + @type list of str + @param branchesList list of branches + @type list of str + @param path pathname to determine the repository URL from + @type str + @param parent parent widget of the dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -106,8 +111,10 @@ Private method used to change the label combo depending on the selected type. - @param labelCombo reference to the labelCombo object (QComboBox) - @param type_ type string (string) + @param labelCombo reference to the labelCombo object + @type QComboBox + @param type_ type string + @type str """ if type_ == "trunk/": labelCombo.clear() @@ -150,8 +157,9 @@ """ Public method to get the entered URLs. - @return tuple of list of two URL strings (list of strings) and - a flag indicating a diff summary (boolean) + @return tuple containing a list of two URL strings and a flag indicating + a diff summary + @rtype tuple of (list of str, bool) """ if self.vcs.otherData["standardLayout"]: url1 = (
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnUtilities.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnUtilities.py Sat Dec 23 15:40:23 2023 +0100 @@ -19,7 +19,8 @@ """ Module function to get the filename of the servers file. - @return filename of the servers file (string) + @return filename of the servers file + @rtype str """ if OSUtilities.isWindowsPlatform(): appdata = os.environ["APPDATA"] @@ -33,7 +34,8 @@ """ Module function to get the filename of the config file. - @return filename of the config file (string) + @return filename of the config file + @rtype str """ if OSUtilities.isWindowsPlatform(): appdata = os.environ["APPDATA"]
--- a/src/eric7/Plugins/VcsPlugins/vcsSubversion/subversion.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsSubversion/subversion.py Sat Dec 23 15:40:23 2023 +0100 @@ -40,8 +40,11 @@ Constructor @param plugin reference to the plugin object - @param parent parent widget (QWidget) - @param name name of this object (string) + @type VcsSubversionPlugin + @param parent parent widget + @type QWidget + @param name name of this object + @type str """ VersionControl.__init__(self, parent, name) self.defaultOptions = { @@ -114,7 +117,8 @@ """ Public method to get a reference to the plugin object. - @return reference to the plugin object (VcsSubversionPlugin) + @return reference to the plugin object + @rtype VcsSubversionPlugin """ return self.__plugin @@ -146,7 +150,8 @@ Public method used to test for the presence of the svn executable. @return flag indicating the existance (boolean) and an error message - (string) + + @rtype str """ self.versionStr = "" errMsg = "" @@ -192,9 +197,12 @@ because the respective command always works locally. Therefore we always return TRUE without doing anything. - @param vcsDir name of the VCS directory (string) - @param noDialog flag indicating quiet operations (boolean) - @return always TRUE + @param vcsDir name of the VCS directory + @type str + @param noDialog flag indicating quiet operations + @type bool + @return always True + @rtype bool """ return True @@ -273,7 +281,7 @@ @param vcsDataDict dictionary of data required for the import @type dict - @param projectDir project directory (string) + @param projectDir project directory @type str @param noDialog flag indicating quiet operations @type bool @@ -339,9 +347,13 @@ repository. @param vcsDataDict dictionary of data required for the checkout - @param projectDir project directory to create (string) + @type dict + @param projectDir project directory to create + @type str @param noDialog flag indicating quiet operations - @return flag indicating an execution without errors (boolean) + @type bool + @return flag indicating an execution without errors + @rtype bool """ noDialog = False try: @@ -400,8 +412,11 @@ repository. @param vcsDataDict dictionary of data required for the checkout - @param projectDir project directory to create (string) - @return flag indicating an execution without errors (boolean) + @type dict + @param projectDir project directory to create + @type str + @return flag indicating an execution without errors + @rtype bool """ try: tag = vcsDataDict["tag"] @@ -453,10 +468,12 @@ Public method used to make the change of a file/directory permanent in the Subversion repository. - @param name file/directory name to be committed (string or list of - strings) - @param message message for this operation (string) + @param name file/directory name to be committed + @type str or list of str + @param message message for this operation + @type str @param noDialog flag indicating quiet operations + @type bool """ from .SvnCommitDialog import SvnCommitDialog @@ -613,11 +630,12 @@ Public method used to update a file/directory with the Subversion repository. - @param name file/directory name to be updated (string or list of - strings) - @param noDialog flag indicating quiet operations (boolean) - @return flag indicating, that the update contained an add - or delete (boolean) + @param name file/directory name to be updated + @type str or list of str + @param noDialog flag indicating quiet operations + @type bool + @return flag indicating, that the update contained an add or delete + @rtype bool """ args = [] args.append("update") @@ -650,9 +668,12 @@ Public method used to add a file/directory to the Subversion repository. - @param name file/directory name to be added (string) - @param isDir flag indicating name is a directory (boolean) + @param name file/directory name to be added + @type str + @param isDir flag indicating name is a directory + @type bool @param noDialog flag indicating quiet operations + @type bool """ args = [] args.append("add") @@ -745,8 +766,10 @@ Public method used to add a file/directory in binary mode to the Subversion repository. - @param name file/directory name to be added (string) - @param isDir flag indicating name is a directory (boolean) + @param name file/directory name to be added + @type str + @param isDir flag indicating name is a directory + @type bool """ self.vcsAdd(name, isDir) @@ -755,8 +778,8 @@ Public method to add a directory tree rooted at path to the Subversion repository. - @param path root directory of the tree to be added (string or list of - strings)) + @param path root directory of the tree to be added + @type str or list of str """ args = [] args.append("add") @@ -835,12 +858,14 @@ The default operation is to remove the local copy as well. - @param name file/directory name to be removed (string or list of - strings)) - @param project flag indicating deletion of a project tree (boolean) - (not needed) + @param name file/directory name to be removed + @type str or list of str + @param project flag indicating deletion of a project tree + @type bool @param noDialog flag indicating quiet operations - @return flag indicating successfull operation (boolean) + @type bool + @return flag indicating successfull operation + @rtype bool """ args = [] args.append("delete") @@ -871,11 +896,16 @@ """ Public method used to move a file/directory. - @param name file/directory name to be moved (string) + @param name file/directory name to be moved + @type str @param project reference to the project object - @param target new name of the file/directory (string) + @type Project + @param target new name of the file/directory + @type str @param noDialog flag indicating quiet operations - @return flag indicating successfull operation (boolean) + @type bool + @return flag indicating successfull operation + @rtype bool """ from .SvnCopyDialog import SvnCopyDialog @@ -945,7 +975,8 @@ being edited and has unsaved modification, they can be saved or the operation may be aborted. - @param name file/directory name to be diffed (string) + @param name file/directory name to be diffed + @type str """ from .SvnDiffDialog import SvnDiffDialog @@ -972,7 +1003,7 @@ Subversion repository. @param name file/directory name(s) to show the status of - (string or list of strings) + @type str or list of str """ from .SvnStatusDialog import SvnStatusDialog @@ -987,7 +1018,8 @@ Public method used to set the tag of a file/directory in the Subversion repository. - @param name file/directory name to be tagged (string) + @param name file/directory name to be tagged + @type str """ from .SvnTagDialog import SvnTagDialog @@ -1136,8 +1168,10 @@ """ Public method used to switch a directory to a different tag/branch. - @param name directory name to be switched (string) - @return flag indicating added or changed files (boolean) + @param name directory name to be switched + @type str + @return flag indicating added or changed files + @rtype bool """ from .SvnSwitchDialog import SvnSwitchDialog @@ -1218,7 +1252,8 @@ """ Public method used to merge a URL/revision into the local project. - @param name file/directory name to be merged (string) + @param name file/directory name to be merged + @type str """ from .SvnMergeDialog import SvnMergeDialog @@ -1281,8 +1316,10 @@ """ Public method used to get the registered state of a file in the vcs. - @param name filename to check (string) - @return a combination of canBeCommited and canBeAdded + @param name filename to check + @type str + @return registered state (one of canBeCommited and canBeAdded) + @rtype int """ if self.__wcng: return self.__vcsRegisteredState_wcng(name) @@ -1296,8 +1333,10 @@ This is the variant for subversion installations using the new working copy meta-data format. - @param name filename to check (string) - @return a combination of canBeCommited and canBeAdded + @param name filename to check + @type str + @return registered state (one of canBeCommited and canBeAdded) + @rtype int """ if name.endswith(os.sep): name = name[:-1] @@ -1325,8 +1364,10 @@ This is the variant for subversion installations using the old working copy meta-data format. - @param name filename to check (string) - @return a combination of canBeCommited and canBeAdded + @param name filename to check + @type str + @return registered state (one of canBeCommited and canBeAdded) + @rtype int """ dname, fname = self.splitPath(name) @@ -1354,10 +1395,14 @@ that the states for all files have been populated by the previous run. @param names dictionary with all filenames to be checked as keys - @param dname directory to check in (string) - @param shortcut flag indicating a shortcut should be taken (boolean) + @type dict + @param dname directory to check in + @type str + @param shortcut flag indicating a shortcut should be taken + @type bool @return the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error + @rtype dict """ if self.__wcng: return self.__vcsAllRegisteredStates_wcng(names, dname) @@ -1377,9 +1422,12 @@ that the states for all files has been populated by the previous run. @param names dictionary with all filenames to be checked as keys - @param dname directory to check in (string) + @type dict + @param dname directory to check in + @type str @return the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error + @rtype dict """ if dname.endswith(os.sep): dname = dname[:-1] @@ -1447,10 +1495,14 @@ that the states for all files has been populated by the previous run. @param names dictionary with all filenames to be checked as keys - @param dname directory to check in (string) - @param shortcut flag indicating a shortcut should be taken (boolean) + @type dict + @param dname directory to check in + @type str + @param shortcut flag indicating a shortcut should be taken + @type bool @return the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error + @rtype dict """ if not os.path.isdir(os.path.join(dname, self.adminDir)): # not under version control -> do nothing @@ -1514,7 +1566,8 @@ This method ensures, that an ignore file exists. - @param project reference to the project (Project) + @param project reference to the project + @type Project """ configPath = getConfigPath() if os.path.exists(configPath): @@ -1526,7 +1579,8 @@ """ Public method returning the name of the vcs. - @return always 'Subversion' (string) + @return always 'Subversion' + @rtype str """ return "Subversion" @@ -1534,7 +1588,8 @@ """ Public method used to cleanup the working copy. - @param name directory name to be cleaned up (string) + @param name directory name to be cleaned up + @type str """ args = [] args.append("cleanup") @@ -1550,7 +1605,8 @@ """ Public method used to execute arbitrary subversion commands. - @param name directory name of the working directory (string) + @param name directory name of the working directory + @type str """ from .SvnCommandDialog import SvnCommandDialog @@ -1583,11 +1639,15 @@ Public method to get a dialog to enter repository info. @param project reference to the project object - @param archive name of the project in the repository (string) + @type Project + @param archive name of the project in the repository + @type str @param editable flag indicating that the project name is editable - (boolean) - @param parent parent widget (QWidget) - @return reference to the instantiated options dialog (SvnOptionsDialog) + @type bool + @param parent parent widget + @type QWidget + @return reference to the instantiated options dialog + @rtype SvnOptionsDialog """ from .SvnOptionsDialog import SvnOptionsDialog @@ -1598,9 +1658,10 @@ Public method to get a dialog to enter repository info for getting a new project. - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget @return reference to the instantiated options dialog - (SvnNewProjectOptionsDialog) + @rtype SvnNewProjectOptionsDialog """ from .SvnNewProjectOptionsDialog import SvnNewProjectOptionsDialog @@ -1610,8 +1671,10 @@ """ Public method to retrieve information about the repository. - @param ppath local path to get the repository infos (string) - @return string with ready formated info for display (string) + @param ppath local path to get the repository infos + @type str + @return string with ready formated info for display + @rtype str """ info = { "committed-rev": "", @@ -1698,8 +1761,10 @@ Public method used to retrieve the URL of the subversion repository path. - @param path local path to get the svn repository path for (string) + @param path local path to get the svn repository path for + @type str @return string with the repository path URL + @rtype str """ ioEncoding = Preferences.getSystem("IOEncoding") @@ -1727,7 +1792,8 @@ """ Public method used to resolve conflicts of a file/directory. - @param name file/directory name to be resolved (string) + @param name file/directory name to be resolved + @type str """ args = [] if self.version >= (1, 5, 0): @@ -1754,9 +1820,12 @@ """ Public method used to copy a file/directory. - @param name file/directory name to be copied (string) + @param name file/directory name to be copied + @type str @param project reference to the project object - @return flag indicating successfull operation (boolean) + @type Project + @return flag indicating successfull operation + @rtype bool """ from .SvnCopyDialog import SvnCopyDialog @@ -1797,8 +1866,10 @@ """ Public method used to list the properties of a file/directory. - @param name file/directory name (string or list of strings) + @param name file/directory name + @type str or list of str @param recursive flag indicating a recursive list is requested + @type bool """ from .SvnPropListDialog import SvnPropListDialog @@ -1812,8 +1883,10 @@ """ Public method used to add a property to a file/directory. - @param name file/directory name (string or list of strings) + @param name file/directory name + @type str or list of str @param recursive flag indicating a recursive list is requested + @type bool """ from .SvnPropSetDialog import SvnPropSetDialog @@ -1853,8 +1926,10 @@ """ Public method used to delete a property of a file/directory. - @param name file/directory name (string or list of strings) + @param name file/directory name + @type str or list of str @param recursive flag indicating a recursive list is requested + @type bool """ propName, ok = QInputDialog.getText( None, @@ -1896,9 +1971,11 @@ """ Public method used to list the available tags or branches. - @param path directory name of the project (string) + @param path directory name of the project + @type str @param tags flag indicating listing of branches or tags - (False = branches, True = tags) + (False = branches, True = tags) + @type bool """ from .SvnTagBranchListDialog import SvnTagBranchListDialog @@ -1929,7 +2006,8 @@ """ Public method to show the output of the svn blame command. - @param name file name to show the blame for (string) + @param name file name to show the blame for + @type str """ from .SvnBlameDialog import SvnBlameDialog @@ -1951,7 +2029,8 @@ This method gives the chance to enter the revisions to be compared. - @param name file/directory name to be diffed (string) + @param name file/directory name to be diffed + @type str """ from .SvnDiffDialog import SvnDiffDialog from .SvnRevisionSelectionDialog import SvnRevisionSelectionDialog @@ -1985,7 +2064,8 @@ This method gives the chance to enter the revisions to be compared. - @param name file/directory name to be diffed (string) + @param name file/directory name to be diffed + @type str """ from .SvnDiffDialog import SvnDiffDialog from .SvnUrlSelectionDialog import SvnUrlSelectionDialog @@ -2016,9 +2096,12 @@ Private method to get a file for a specific revision from the repository. - @param name file name to get from the repository (string) - @param rev revision to retrieve (integer or string) - @return contents of the file (string) and an error message (string) + @param name file name to get from the repository + @type str + @param rev revision to retrieve + @type int or str + @return contents of the file (string) and an error message + @rtype str """ args = [] args.append("cat") @@ -2063,9 +2146,12 @@ Public method used to view the difference of a file to the Mercurial repository side-by-side. - @param name file name to be diffed (string) - @param extended flag indicating the extended variant (boolean) - @param revisions tuple of two revisions (tuple of strings) + @param name file name to be diffed + @type str + @param extended flag indicating the extended variant + @type bool + @param revisions tuple of two revisions + @type tuple of (str, str) @exception ValueError raised to indicate an illegal name parameter type """ from eric7.UI.CompareDialog import CompareDialog @@ -2132,8 +2218,10 @@ Public method used to browse the log of a file/directory from the Subversion repository. - @param name file/directory name to show the log of (string) - @param isFile flag indicating log for a file is to be shown (boolean) + @param name file/directory name to show the log of + @type str + @param isFile flag indicating log for a file is to be shown + @type bool """ from .SvnLogBrowserDialog import SvnLogBrowserDialog @@ -2147,11 +2235,12 @@ """ Public method used to lock a file in the Subversion repository. - @param name file/directory name to be locked (string or list of - strings) - @param stealIt flag indicating a forced operation (boolean) + @param name file/directory name to be locked + @type str or list of str + @param stealIt flag indicating a forced operation + @type bool @param parent reference to the parent object of the subversion dialog - (QWidget) + @type QWidget """ args = [] args.append("lock") @@ -2174,11 +2263,12 @@ """ Public method used to unlock a file in the Subversion repository. - @param name file/directory name to be unlocked (string or list of - strings) - @param breakIt flag indicating a forced operation (boolean) + @param name file/directory name to be unlocked + @type str or list of str + @param breakIt flag indicating a forced operation + @type bool @param parent reference to the parent object of the subversion dialog - (QWidget) + @type QWidget """ args = [] args.append("unlock") @@ -2201,7 +2291,8 @@ """ Public method to relocate the working copy to a new repository URL. - @param projectPath path name of the project (string) + @param projectPath path name of the project + @type str """ from .SvnRelocateDialog import SvnRelocateDialog @@ -2226,7 +2317,8 @@ """ Public method to open the repository browser. - @param projectPath path name of the project (string) + @param projectPath path name of the project + @type str """ from .SvnRepoBrowserDialog import SvnRepoBrowserDialog @@ -2255,7 +2347,7 @@ Note: Directories will be removed recursively. @param names name or list of names of file or directory to remove - (string) + @type str or list of str """ args = [] args.append("changelist") @@ -2281,7 +2373,7 @@ Note: Directories will be added recursively. @param names name or list of names of file or directory to add - (string) + @type str or list of str """ clname, ok = QInputDialog.getItem( None, @@ -2315,7 +2407,8 @@ """ Public method used to inspect the change lists defined for the project. - @param path directory name to show change lists for (string) + @param path directory name to show change lists for + @type str """ from .SvnChangeListsDialog import SvnChangeListsDialog @@ -2328,7 +2421,8 @@ """ Public method to get a list of all defined change lists. - @return list of defined change list names (list of strings) + @return list of defined change list names + @rtype list of str """ changelists = [] rx_changelist = re.compile("--- \\S+ .([\\w\\s]+).:\\s*") @@ -2367,7 +2461,8 @@ """ Public method to upgrade the working copy format. - @param path directory name to show change lists for (string) + @param path directory name to show change lists for + @type str """ args = [] args.append("upgrade") @@ -2386,8 +2481,10 @@ """ Private method to format a url for subversion. - @param url unformatted url string (string) - @return properly formated url for subversion (string) + @param url unformatted url string + @type str + @return properly formated url for subversion + @rtype str """ url = self.svnNormalizeURL(url) url = url.split(":", 2) @@ -2412,8 +2509,10 @@ """ Public method to normalize a url for subversion. - @param url url string (string) - @return properly normalized url for subversion (string) + @param url url string + @type str + @return properly normalized url for subversion + @rtype str """ protocol, url = url.split("://", 1) if url.startswith("\\\\"): @@ -2437,10 +2536,14 @@ project browsers. @param browser reference to the project browser object + @type ProjectBaseBrowser @param project reference to the project object + @type Project @param isTranslationsBrowser flag indicating, the helper is requested for the translations browser (this needs some special treatment) + @type bool @return the project browser helper object + @rtype SvnProjectBrowserHelper """ from .ProjectBrowserHelper import SvnProjectBrowserHelper @@ -2451,7 +2554,9 @@ Public method to instanciate a helper object for the project. @param project reference to the project object + @type Project @return the project helper object + @rtype SvnProjectHelper """ helper = self.__plugin.getProjectHelper() helper.setObjects(self, project) @@ -2473,9 +2578,11 @@ thread. @param interval check interval for the monitor thread in seconds - (integer) + @type int @param project reference to the project object - @return reference to the monitor thread (QThread) + @type Project + @return reference to the monitor thread + @rtype SvnStatusMonitorThread """ from .SvnStatusMonitorThread import SvnStatusMonitorThread
--- a/src/eric7/VCS/ProjectBrowserHelper.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/VCS/ProjectBrowserHelper.py Sat Dec 23 15:40:23 2023 +0100 @@ -95,7 +95,7 @@ @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status - @type list of BrowserItem + @type list of QAction @exception NotImplementedError to indicate that this method must be implemented by a subclass """ @@ -113,7 +113,7 @@ @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status - @type list of BrowserItem + @type list of QAction @exception NotImplementedError to indicate that this method must be implemented by a subclass """ @@ -130,7 +130,7 @@ @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status - @type list of BrowserItem + @type list of QAction @exception NotImplementedError to indicate that this method must be implemented by a subclass """ @@ -147,7 +147,7 @@ @type QMenu @param standardItems array of standard items that need activation/deactivation depending on the overall VCS status - @type list of BrowserItem + @type list of QAction @exception NotImplementedError to indicate that this method must be implemented by a subclass """
--- a/src/eric7/VCS/VersionControl.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/VCS/VersionControl.py Sat Dec 23 15:40:23 2023 +0100 @@ -562,8 +562,7 @@ @param name filename to check @type str - @return a combination of canBeCommited and canBeAdded or - 0 in order to signal an error + @return registered state (one of canBeCommited and canBeAdded) @rtype int @exception NotImplementedError to indicate that this method must be implemented by a subclass