/rev/199782817963
changeset: 1238:199782817963
user: Janus Dam Nielsen <[email protected]>
date: Thu Oct 08 11:51:56 2009 +0200
summary: Added documentation for constants.py.
diffstat:
doc/constants.txt | 24 ++++++++++++++++++++++++
doc/implementation.txt | 1 +
doc/runtime.txt | 10 ----------
3 files changed, 25 insertions(+), 10 deletions(-)
diffs (56 lines):
diff -r 4b6f9e4db99e -r 199782817963 doc/constants.txt
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/constants.txt Thu Oct 08 11:51:56 2009 +0200
@@ -0,0 +1,24 @@
+Constants Module
+================
+
+.. automodule:: viff.constants
+
+ .. attribute:: SHARE
+ ECHO
+ READY
+ SEND
+ PAILLIER
+ TEXT
+
+ Constants used by :class:`ShareExchanger` and others when sending
+ shares and other messages. They serve to distinguish messages sent
+ with the same program counter from one another.
+
+ .. attribute::INCONSISTENTHASH
+ OK
+ HASH
+ SIGNAL
+
+ Constants used by :class:`HashBroadcastMixin` when sending shares
+ and other messages. They serve to distinguish messages sent with
+ the same program counter from one another.
diff -r 4b6f9e4db99e -r 199782817963 doc/implementation.txt
--- a/doc/implementation.txt Wed Oct 07 12:03:06 2009 +0200
+++ b/doc/implementation.txt Thu Oct 08 11:51:56 2009 +0200
@@ -19,3 +19,4 @@
prss
config
aes
+ constants
diff -r 4b6f9e4db99e -r 199782817963 doc/runtime.txt
--- a/doc/runtime.txt Wed Oct 07 12:03:06 2009 +0200
+++ b/doc/runtime.txt Thu Oct 08 11:51:56 2009 +0200
@@ -21,16 +21,6 @@
or the data itself if data is received from the other player
before we are ready to use it.
- .. attribute:: SHARE
- ECHO
- READY
- SEND
- PAILLIER
-
- Constants used by :class:`ShareExchanger` when sending shares
- and other messages. They serve to distinguish messages sent with
- the same program counter from one another.
-
.. autofunction:: preprocess
See also :ref:`preprocessing` for more background information.
_______________________________________________
viff-commits mailing list
[email protected]
http://lists.viff.dk/listinfo.cgi/viff-commits-viff.dk
