summaryrefslogtreecommitdiff
path: root/src/leap/common/check.py
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2013-05-29 05:00:22 +0900
committerKali Kaneko <kali@leap.se>2013-05-29 05:05:09 +0900
commit354467c605f07042568c10c3e931f7fc093c0bf4 (patch)
tree6dd8abad51635726d3a2cb09caabbe14097de07a /src/leap/common/check.py
parent9c12f4cce20ea1dea7e39cda583cb29ded4b4e1a (diff)
change docstring comments to use sphinx style
Diffstat (limited to 'src/leap/common/check.py')
-rw-r--r--src/leap/common/check.py16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/leap/common/check.py b/src/leap/common/check.py
index 359673b..a2d39a6 100644
--- a/src/leap/common/check.py
+++ b/src/leap/common/check.py
@@ -31,10 +31,10 @@ def leap_assert(condition, message=""):
Asserts the condition and displays the message if that's not
met. It also logs the error and its backtrace.
- @param condition: condition to check
- @type condition: bool
- @param message: message to display if the condition isn't met
- @type message: str
+ :param condition: condition to check
+ :type condition: bool
+ :param message: message to display if the condition isn't met
+ :type message: str
"""
if not condition:
logger.error("Bug: %s" % (message,))
@@ -51,10 +51,10 @@ def leap_assert_type(var, expectedType):
"""
Helper assert check for a variable's expected type
- @param var: variable to check
- @type var: any
- @param expectedType: type to check agains
- @type expectedType: type
+ :param var: variable to check
+ :type var: any
+ :param expectedType: type to check agains
+ :type expectedType: type
"""
leap_assert(isinstance(var, expectedType),
"Expected type %r instead of %r" %