changeset 795:cfdce3e99171

Added warning about return type of Toft05 comparison.
author Martin Geisler <mg@daimi.au.dk>
date Wed, 28 May 2008 09:27:38 +0200
parents 2472ea5263f5
children 73af810f6bb1
files viff/comparison.py
diffstat 1 files changed, 7 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/viff/comparison.py	Mon May 26 22:28:29 2008 +0200
+++ b/viff/comparison.py	Wed May 28 09:27:38 2008 +0200
@@ -57,7 +57,13 @@
         """Compute ``share_a >= share_b``.
 
         Both arguments must be from the field given. The result is a
-        GF256 share.
+        :class:`GF256 <viff.field.GF256>` share.
+
+        .. warning::
+
+           The result type (:class:`viff.field.GF256`) is different
+           from the argument types (general field elements).
+
         """
         field = getattr(share_a, "field", getattr(share_b, "field", None))
         if not isinstance(share_a, Share):