[Xen-changelog] Added doccomment.

[Xen patchbot -unstable <patchbot-unstable@xxxxxxxxxxxxxxxxxxx>]

# HG changeset patch
# User emellor@ewan
# Node ID 813bc65bde2ad72514942b5202673a5e40889a2d
# Parent  dfadbb90d09266f63da7c4d65bc5d10abecc8165
Added doccomment.

Signed-off-by: Ewan Mellor <ewan@xxxxxxxxxxxxx>

diff -r dfadbb90d092 -r 813bc65bde2a tools/python/xen/util/asserts.py
--- a/tools/python/xen/util/asserts.py  Tue Oct 11 09:29:29 2005
+++ b/tools/python/xen/util/asserts.py  Tue Oct 11 09:30:13 2005
@@ -17,6 +17,11 @@
 
 
 def isCharConvertible(c):
+    """Assert that the given value is convertible to a character using the %c
+    conversion.  This implies that c is either an integer, or a character
+    (i.e. a string of length 1).
+    """
+    
     assert (isinstance(c, int) or
             (isinstance(c, str) and
              len(c) == 1)), "%s is not convertible to a character" % c

_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-changelog