changeset 734:db9a7bdd9d68

Document BasicRuntime.id and .threshold.
author Martin Geisler <mg@daimi.au.dk>
date Thu, 24 Apr 2008 14:59:21 +0200
parents 1f206d21e988
children f51415df0335
files doc/runtime.txt
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/runtime.txt	Thu Apr 24 14:53:43 2008 +0200
+++ b/doc/runtime.txt	Thu Apr 24 14:59:21 2008 +0200
@@ -28,6 +28,16 @@
    .. autoclass:: BasicRuntime
       :members:
 
+      .. attribute:: BasicRuntime.id
+
+         Player ID. This is an integer in the range 1--*n* for *n*
+         players.
+
+      .. attribute:: BasicRuntime.threshold
+
+         Default threshold used by :meth:`Runtime.shamir_share`,
+         :meth:`Runtime.open`, and others.
+
       .. attribute:: BasicRuntime.program_counter
 
          Whenever a share is sent over the network, it must be