--- 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"
