Skip to content

Commit 36d153c

Browse files
committed
Updated docstring to follow Google Style instead of ReText.
1 parent 7f60cef commit 36d153c

1 file changed

Lines changed: 47 additions & 24 deletions

File tree

exercises/concept/black-jack/black_jack.py

Lines changed: 47 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,15 @@
88
def value_of_card(card):
99
"""Determine the scoring value of a card.
1010
11-
:param card: str - given card.
12-
:return: int - value of a given card. See below for values.
11+
Parameters:
12+
card (str): The given card.
1313
14-
1. 'J', 'Q', or 'K' (otherwise known as "face cards") = 10
15-
2. 'A' (ace card) = 1
16-
3. '2' - '10' = numerical value.
14+
Returns:
15+
int: The value of a given card. See below for values.
16+
17+
1. 'J', 'Q', or 'K' (otherwise known as "face cards") = 10
18+
2. 'A' (ace card) = 1
19+
3. '2' - '10' = numerical value.
1720
"""
1821

1922
pass
@@ -22,12 +25,16 @@ def value_of_card(card):
2225
def higher_card(card_one, card_two):
2326
"""Determine which card has a higher value in the hand.
2427
25-
:param card_one, card_two: str - cards dealt in hand. See below for values.
26-
:return: str or tuple - resulting Tuple contains both cards if they are of equal value.
28+
Parameters:
29+
card_one (str): First card dealt in the hand. See below for values.
30+
card_two (str): Second card dealt in the hand. See below for values.
31+
32+
1. 'J', 'Q', or 'K' (otherwise known as "face cards") = 10
33+
2. 'A' (ace card) = 1
34+
3. '2' - '10' = numerical value.
2735
28-
1. 'J', 'Q', or 'K' (otherwise known as "face cards") = 10
29-
2. 'A' (ace card) = 1
30-
3. '2' - '10' = numerical value.
36+
Returns:
37+
str or tuple: The resulting Tuple contains both cards if they are of equal value.
3138
"""
3239

3340
pass
@@ -36,12 +43,16 @@ def higher_card(card_one, card_two):
3643
def value_of_ace(card_one, card_two):
3744
"""Calculate the most advantageous value for an upcoming ace card.
3845
39-
:param card_one, card_two: str - card dealt. See below for values.
40-
:return: int - either 1 or 11 value of the upcoming ace card.
46+
Parameters:
47+
card_one (str): First card dealt in the hand. See below for values.
48+
card_two (str): Second card dealt in the hand. See below for values.
49+
50+
1. 'J', 'Q', or 'K' (otherwise known as "face cards") = 10
51+
2. 'A' (ace card) = 11 (if already in hand)
52+
3. '2' - '10' = numerical value.
4153
42-
1. 'J', 'Q', or 'K' (otherwise known as "face cards") = 10
43-
2. 'A' (ace card) = 11 (if already in hand)
44-
3. '2' - '10' = numerical value.
54+
Returns:
55+
int: Either 1 or 11, which is the value of the upcoming ace card.
4556
"""
4657

4758
pass
@@ -50,12 +61,16 @@ def value_of_ace(card_one, card_two):
5061
def is_blackjack(card_one, card_two):
5162
"""Determine if the hand is a 'natural' or 'blackjack'.
5263
53-
:param card_one, card_two: str - card dealt. See below for values.
54-
:return: bool - is the hand is a blackjack (two cards worth 21).
64+
Parameters:
65+
card_one (str): First card dealt in the hand. See below for values.
66+
card_two (str): Second card dealt in the hand. See below for values.
5567
56-
1. 'J', 'Q', or 'K' (otherwise known as "face cards") = 10
57-
2. 'A' (ace card) = 11 (if already in hand)
58-
3. '2' - '10' = numerical value.
68+
1. 'J', 'Q', or 'K' (otherwise known as "face cards") = 10
69+
2. 'A' (ace card) = 11 (if already in hand)
70+
3. '2' - '10' = numerical value.
71+
72+
Returns:
73+
bool: Is the hand is a blackjack (two cards worth 21).
5974
"""
6075

6176
pass
@@ -64,8 +79,12 @@ def is_blackjack(card_one, card_two):
6479
def can_split_pairs(card_one, card_two):
6580
"""Determine if a player can split their hand into two hands.
6681
67-
:param card_one, card_two: str - cards dealt.
68-
:return: bool - can the hand be split into two pairs? (i.e. cards are of the same value).
82+
Parameters:
83+
card_one (str): First card in the hand.
84+
card_two (str): Second card in the hand.
85+
86+
Returns:
87+
bool: Can the hand be split into two pairs? (i.e. cards are of the same value).
6988
"""
7089

7190
pass
@@ -74,8 +93,12 @@ def can_split_pairs(card_one, card_two):
7493
def can_double_down(card_one, card_two):
7594
"""Determine if a blackjack player can place a double down bet.
7695
77-
:param card_one, card_two: str - first and second cards in hand.
78-
:return: bool - can the hand can be doubled down? (i.e. totals 9, 10 or 11 points).
96+
Parameters:
97+
card_one (str): First card in the hand.
98+
card_two (str): Second card in the hand.
99+
100+
Returns:
101+
bool: Can the hand can be doubled down? (i.e. totals 9, 10 or 11 points).
79102
"""
80103

81104
pass

0 commit comments

Comments
 (0)