From 92e2e0ca9502d27525e986c920548dd974bdef24 Mon Sep 17 00:00:00 2001 From: Worros Date: Fri, 20 Aug 2010 21:05:33 +0800 Subject: [PATCH] HHC: Update doco on markStreets --- pyfpdb/HandHistoryConverter.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/pyfpdb/HandHistoryConverter.py b/pyfpdb/HandHistoryConverter.py index a521f248..7169b668 100644 --- a/pyfpdb/HandHistoryConverter.py +++ b/pyfpdb/HandHistoryConverter.py @@ -391,6 +391,24 @@ or None if we fail to get the info """ # so groups are called by street names 'PREFLOP', 'FLOP', 'STREET2' etc # blinds are done seperately def markStreets(self, hand): abstract + """For dividing the handText into sections. + + The function requires you to pass a MatchObject with groups specifically labeled with + the 'correct' street names. + + The Hand object will use the various matches for assigning actions to the correct streets. + + Flop Based Games: + PREFLOP, FLOP, TURN, RIVER + + Draw Based Games: + PREDEAL, DEAL, DRAWONE, DRAWTWO, DRAWTHREE + + Stud Based Games: + ANTES, THIRD, FOURTH, FIFTH, SIXTH, SEVENTH + + The Stars HHC has a good reference implementation + """ #Needs to return a list in the format # ['player1name', 'player2name', ...] where player1name is the sb and player2name is bb,