Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AussieSeaweed committed Jun 14, 2024
1 parent 57cc656 commit 97c08de
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/simulation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
5 changes: 3 additions & 2 deletions pokerkit/state.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 97c08de

Please sign in to comment.