summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Alejandro <ivanalejandro0@gmail.com>2014-04-17 11:45:03 -0300
committerIvan Alejandro <ivanalejandro0@gmail.com>2014-04-17 12:12:26 -0300
commitfa81e2f08335334f8def3a9275c00ba133e5f714 (patch)
tree56b8a7c131f0c9e4be5b58518e140c4d7a659245
parent5218fda6b524cb8e694113e123e7b0d05b205ddc (diff)
Improve parameters docstrings.
Also rename a parameter named 'param' to a more meaningful 'idx'.
-rw-r--r--src/leap/bitmask/gui/eip_preferenceswindow.py3
-rw-r--r--src/leap/bitmask/gui/eip_status.py3
-rw-r--r--src/leap/bitmask/gui/login.py9
-rw-r--r--src/leap/bitmask/gui/mainwindow.py8
-rw-r--r--src/leap/bitmask/gui/wizard.py8
5 files changed, 27 insertions, 4 deletions
diff --git a/src/leap/bitmask/gui/eip_preferenceswindow.py b/src/leap/bitmask/gui/eip_preferenceswindow.py
index fd2d3c5d..530cd38d 100644
--- a/src/leap/bitmask/gui/eip_preferenceswindow.py
+++ b/src/leap/bitmask/gui/eip_preferenceswindow.py
@@ -182,6 +182,9 @@ class EIPPreferencesWindow(QtGui.QDialog):
TRIGGERS:
Signaler.eip_get_gateways_list
+ :param gateways: a list of gateways
+ :type gateways: list of unicode
+
Add the available gateways and select the one stored in configuration
file.
"""
diff --git a/src/leap/bitmask/gui/eip_status.py b/src/leap/bitmask/gui/eip_status.py
index 8f4d64b4..0d75b8e5 100644
--- a/src/leap/bitmask/gui/eip_status.py
+++ b/src/leap/bitmask/gui/eip_status.py
@@ -392,6 +392,9 @@ class EIPStatusWidget(QtGui.QWidget):
Updates the displayed VPN state based on the data provided by
the VPN thread.
+ :param vpn_state: the state of the VPN
+ :type vpn_state: dict
+
Emits:
If the vpn_state is connected, we emit EIPConnection.qtsigs.
connected_signal
diff --git a/src/leap/bitmask/gui/login.py b/src/leap/bitmask/gui/login.py
index 681c0915..ac7ad878 100644
--- a/src/leap/bitmask/gui/login.py
+++ b/src/leap/bitmask/gui/login.py
@@ -259,13 +259,16 @@ class LoginWidget(QtGui.QWidget):
"""
self.ui.lnPassword.setFocus()
- def _current_provider_changed(self, param):
@QtCore.Slot(int)
+ def _current_provider_changed(self, idx):
"""
TRIGGERS:
self.ui.cmbProviders.currentIndexChanged
+
+ :param idx: the index of the new selected item
+ :type idx: int
"""
- if param == (self.ui.cmbProviders.count() - 1):
+ if idx == (self.ui.cmbProviders.count() - 1):
self.show_wizard.emit()
# Leave the previously selected provider in the combobox
prev_provider = 0
@@ -275,7 +278,7 @@ class LoginWidget(QtGui.QWidget):
self.ui.cmbProviders.setCurrentIndex(prev_provider)
self.ui.cmbProviders.blockSignals(False)
else:
- self._selected_provider_index = param
+ self._selected_provider_index = idx
def start_login(self):
"""
diff --git a/src/leap/bitmask/gui/mainwindow.py b/src/leap/bitmask/gui/mainwindow.py
index 708ecf7f..b911e5d8 100644
--- a/src/leap/bitmask/gui/mainwindow.py
+++ b/src/leap/bitmask/gui/mainwindow.py
@@ -652,9 +652,12 @@ class MainWindow(QtGui.QMainWindow):
def _react_to_new_updates(self, req):
"""
TRIGGERS:
- self._new_updates_available
+ self.new_updates
Displays the new updates label and sets the updates_content
+
+ :param req: Request type
+ :type req: leap.common.events.events_pb2.SignalRequest
"""
self.moveToThread(QtCore.QCoreApplication.instance().thread())
self.ui.lblNewUpdates.setVisible(True)
@@ -841,6 +844,9 @@ class MainWindow(QtGui.QMainWindow):
TRIGGERS:
self._systray.activated
+ :param reason: the reason why the tray got activated.
+ :type reason: int
+
Displays the context menu from the tray icon
"""
self._update_hideshow_menu()
diff --git a/src/leap/bitmask/gui/wizard.py b/src/leap/bitmask/gui/wizard.py
index 957a67e0..cc8c2624 100644
--- a/src/leap/bitmask/gui/wizard.py
+++ b/src/leap/bitmask/gui/wizard.py
@@ -217,6 +217,11 @@ class Wizard(QtGui.QWizard):
Enables/disables the 'check' button in the SELECT_PROVIDER_PAGE
depending on the lnProvider content.
+
+ :param reset: this contains the text of the line edit, and when is
+ called directly defines whether we want to reset the
+ checks.
+ :type reset: unicode or bool
"""
enabled = len(self.ui.lnProvider.text()) != 0
enabled = enabled or self.ui.rbExistingProvider.isChecked()
@@ -617,6 +622,9 @@ class Wizard(QtGui.QWizard):
self.currentIdChanged
Prepares the pages when they appear
+
+ :param pageId: the new current page id.
+ :type pageId: int
"""
if pageId == self.SELECT_PROVIDER_PAGE:
self._clear_register_widgets()