From 97c08deb1c279036e41be03d8e371703bf065b13 Mon Sep 17 00:00:00 2001 From: Juho Kim Date: Fri, 14 Jun 2024 05:18:16 -0400 Subject: [PATCH] Update documentation --- docs/simulation.rst | 2 +- pokerkit/state.py | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/simulation.rst b/docs/simulation.rst index 6d4bb91..61b360e 100644 --- a/docs/simulation.rst +++ b/docs/simulation.rst @@ -1038,7 +1038,7 @@ Helper Method/Attribute Description Chips Pushing Phase/Operation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This operation (:meth:`pokerkit.state.State.push_chips`) corresponds to pushing the chips to the winner(s). Each call pushes one pot (main/side). If multiple players with differing starting stack sizes are all-in and are entitled to the piece of the pot, multiple pots (main + side) will exist and therefore, this method must be invoked multiple times until all pots are pushed to the players. +This operation (:meth:`pokerkit.state.State.push_chips`) corresponds to pushing the chips to the winner(s). Each call pushes one split pot (main/side). If there are multiple hand types (or boards) and/or multiple players with differing starting stack sizes that are all-in and are entitled to the piece of the pot, multiple split pots (main + side) will exist and therefore, this method must be invoked multiple times until all pots are pushed to the players. Chips Pulling Phase/Operation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/pokerkit/state.py b/pokerkit/state.py index 2844ecf..e57ab09 100644 --- a/pokerkit/state.py +++ b/pokerkit/state.py @@ -381,7 +381,7 @@ class Automation(StrEnum): """The chips pushing automation. When automated, the chips pushing is done one by one, for each - main/side pot. + split main/side pot. """ CHIPS_PULLING: str = 'Chips pulling' """The chips pulling automation. @@ -5892,7 +5892,8 @@ def can_push_chips(self) -> bool: def push_chips(self, *, commentary: str | None = None) -> ChipsPushing: """Push chips. - Each call of this operation will push a single main/side pot. + Each call of this operation will push a single split main/side + pot. :param commentary: The optional commentary. :return: The chips pushing.