Skip to content

Commit 8f990c4

Browse files
committed
Update docstring to reflect change in return type
1 parent 89cf7c8 commit 8f990c4

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

src/flip_coins.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
import pandas
77

88

9-
def flip_coin(chosen_side: str) -> dict:
9+
def flip_coin(chosen_side: str) -> pandas.DataFrame:
1010
"""Return the result of a single coin flip given the chosen side
1111
1212
:param str chosen_side: The player's chosen side ("heads", "tails")
13-
:return: the result of the single coin flip
14-
:rtype: dict
13+
:return: the result of the single coin flip in a dataframe
14+
:rtype: pandas.DataFrame
1515
:raises ValueError: if the chosen_side is empty or not "heads" or "tails"
1616
:raises TypeError: if the chosen_side is not a string
1717

0 commit comments

Comments
 (0)