From 96eaddedd7f09fcbcc390aedd7078aeecfa4c885 Mon Sep 17 00:00:00 2001
From: kali <kali@leap.se>
Date: Fri, 3 May 2013 02:59:22 +0900
Subject: updated documentation

* documentation reviewed after rewrite, ready for 0.2.1
* updated docstrings format to fit sphinx autodoc
---
 src/leap/util/checkerthread.py      | 10 +++++-----
 src/leap/util/privilege_policies.py |  6 +++---
 src/leap/util/request_helpers.py    |  6 +++---
 3 files changed, 11 insertions(+), 11 deletions(-)

(limited to 'src/leap/util')

diff --git a/src/leap/util/checkerthread.py b/src/leap/util/checkerthread.py
index 47a96ec5..02aa333f 100644
--- a/src/leap/util/checkerthread.py
+++ b/src/leap/util/checkerthread.py
@@ -48,10 +48,10 @@ class CheckerThread(QtCore.QThread):
 
     def get_should_quit(self):
         """
-        Returns wether this thread should quit
+        Returns whether this thread should quit
 
-        @rtype: bool
-        @return: True if the thread should terminate itself, Flase otherwise
+        :return: True if the thread should terminate itself, Flase otherwise
+        :rtype: bool
         """
 
         QtCore.QMutexLocker(self._should_quit_lock)
@@ -78,8 +78,8 @@ class CheckerThread(QtCore.QThread):
         """
         Adds a list of checks to the ones being executed
 
-        @param checks: check functions to perform
-        @type checkes: list
+        :param checks: check functions to perform
+        :type checkes: list
         """
         with QtCore.QMutexLocker(self._checks_lock):
             self._checks += checks
diff --git a/src/leap/util/privilege_policies.py b/src/leap/util/privilege_policies.py
index e74c4d33..10224bcd 100644
--- a/src/leap/util/privilege_policies.py
+++ b/src/leap/util/privilege_policies.py
@@ -33,7 +33,7 @@ def is_missing_policy_permissions():
     platform, or if the policy checker exists but it cannot find the
     appropriate policy mechanisms in place.
 
-    @rtype: bool
+    :rtype: bool
     """
     _system = platform.system()
     platform_checker = _system + "PolicyChecker"
@@ -60,7 +60,7 @@ class PolicyChecker:
         Returns True if we could not find any policy mechanisms that
         are defined to be in used for this particular platform.
 
-        @rtype: bool
+        :rtype: bool
         """
         return True
 
@@ -77,6 +77,6 @@ class LinuxPolicyChecker(PolicyChecker):
         Returns True if we could not find the appropriate policykit file
         in place
 
-        @rtype: bool
+        :rtype: bool
         """
         return not os.path.isfile(self.LINUX_POLKIT_FILE)
diff --git a/src/leap/util/request_helpers.py b/src/leap/util/request_helpers.py
index 019ff353..e06dabb8 100644
--- a/src/leap/util/request_helpers.py
+++ b/src/leap/util/request_helpers.py
@@ -32,10 +32,10 @@ def get_content(request):
     property/function or from content, in that order.
     Also returns the mtime for that content if available
 
-    @param request: request as it is given by requests
-    @type request: Response
+    :param request: request as it is given by requests
+    :type request: Response
 
-    @rtype: tuple (contents, mtime)
+    :rtype: tuple (contents, mtime)
     """
 
     contents = ""
-- 
cgit v1.2.3