From 8ffb984d259c8373f183a0ac8a66f67a16139e46 Mon Sep 17 00:00:00 2001
From: Worros <carl.gherardi@gmail.com>
Date: Fri, 20 Aug 2010 18:52:00 +0800
Subject: [PATCH] HHC: Better doco for readHandInfo

---
 pyfpdb/HandHistoryConverter.py | 29 +++++++++++++++++++++--------
 1 file changed, 21 insertions(+), 8 deletions(-)

diff --git a/pyfpdb/HandHistoryConverter.py b/pyfpdb/HandHistoryConverter.py
index 34619c40..6308b755 100644
--- a/pyfpdb/HandHistoryConverter.py
+++ b/pyfpdb/HandHistoryConverter.py
@@ -326,15 +326,28 @@ which it expects to find at self.re_TailSplitHands -- see for e.g. Everleaf.py.
 or None if we fail to get the info """
     #TODO: which parts are optional/required?
 
-    # Read any of:
-    # HID       HandID
-    # TABLE     Table name
-    # SB        small blind
-    # BB        big blind
-    # GAMETYPE  gametype
-    # YEAR MON DAY HR MIN SEC   datetime
-    # BUTTON    button seat number
     def readHandInfo(self, hand): abstract
+    """Read and set information about the hand being dealt, and set the correct 
+    variables in the Hand object 'hand
+
+    * hand.startTime - a datetime object
+    * hand.handid - The site identified for the hand - a string.
+    * hand.tablename
+    * hand.buttonpos
+    * hand.maxseats
+    * hand.mixed
+
+    Tournament fields:
+
+    * hand.tourNo - The site identified tournament id as appropriate - a string.
+    * hand.buyin
+    * hand.fee
+    * hand.buyinCurrency
+    * hand.koBounty
+    * hand.isKO
+    * hand.level
+    """
+    #TODO: which parts are optional/required?
 
     # Needs to return a list of lists in the format
     # [['seat#', 'player1name', 'stacksize'] ['seat#', 'player2name', 'stacksize'] [...]]