Skip to content

Commit c277620

Browse files
authored
[List Methods Concept Exercise]: Update docstrings for chaitanas-collossal-coaster (#4144)
* Updated stub docstrings to match google style. * Reformatted docstrings in stub to align with Google Style guide. * Reverting change to currency exchange since this is a different exercise.
1 parent 826ce61 commit c277620

1 file changed

Lines changed: 43 additions & 22 deletions

File tree

exercises/concept/chaitanas-colossal-coaster/list_methods.py

Lines changed: 43 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@
44
def add_me_to_the_queue(express_queue, normal_queue, ticket_type, person_name):
55
"""Add a person to the 'express' or 'normal' queue depending on the ticket number.
66
7-
:param express_queue: list - names in the Fast-track queue.
8-
:param normal_queue: list - names in the normal queue.
9-
:param ticket_type: int - type of ticket. 1 = express, 0 = normal.
10-
:param person_name: str - name of person to add to a queue.
11-
:return: list - the (updated) queue the name was added to.
7+
Parameters:
8+
express_queue (list): The names in the Fast-track queue.
9+
normal_queue (list): The names in the normal queue.
10+
ticket_type (int): Type of ticket. 1 = express, 0 = normal.
11+
person_name (str): The name of person to add to a queue.
12+
13+
Returns:
14+
list: The (updated) queue the name was added to.
1215
"""
1316

1417
pass
@@ -17,9 +20,12 @@ def add_me_to_the_queue(express_queue, normal_queue, ticket_type, person_name):
1720
def find_my_friend(queue, friend_name):
1821
"""Search the queue for a name and return their queue position (index).
1922
20-
:param queue: list - names in the queue.
21-
:param friend_name: str - name of friend to find.
22-
:return: int - index at which the friends name was found.
23+
Parameters:
24+
queue (list): The names in the queue.
25+
friend_name (str): The name of friend to find.
26+
27+
Returns:
28+
int: The index at which the friends name was found.
2329
"""
2430

2531
pass
@@ -28,10 +34,13 @@ def find_my_friend(queue, friend_name):
2834
def add_me_with_my_friends(queue, index, person_name):
2935
"""Insert the late arrival's name at a specific index of the queue.
3036
31-
:param queue: list - names in the queue.
32-
:param index: int - the index at which to add the new name.
33-
:param person_name: str - the name to add.
34-
:return: list - queue updated with new name.
37+
Parameters:
38+
queue (list): The names in the queue.
39+
index (int): The index at which to add the new name.
40+
person_name (str): The name to add.
41+
42+
Returns:
43+
list: The queue updated with new name.
3544
"""
3645

3746
pass
@@ -40,9 +49,12 @@ def add_me_with_my_friends(queue, index, person_name):
4049
def remove_the_mean_person(queue, person_name):
4150
"""Remove the mean person from the queue by the provided name.
4251
43-
:param queue: list - names in the queue.
44-
:param person_name: str - name of mean person.
45-
:return: list - queue update with the mean persons name removed.
52+
Parameters:
53+
queue (list): The names in the queue.
54+
person_name (str): The name of mean person.
55+
56+
Returns:
57+
list: The queue updated with the mean persons name removed.
4658
"""
4759

4860
pass
@@ -51,9 +63,12 @@ def remove_the_mean_person(queue, person_name):
5163
def how_many_namefellows(queue, person_name):
5264
"""Count how many times the provided name appears in the queue.
5365
54-
:param queue: list - names in the queue.
55-
:param person_name: str - name you wish to count or track.
56-
:return: int - the number of times the name appears in the queue.
66+
Parameters:
67+
queue (list): The names in the queue.
68+
person_name (str): The name you wish to count or track.
69+
70+
Returns:
71+
int: The number of times the name appears in the queue.
5772
"""
5873

5974
pass
@@ -62,8 +77,11 @@ def how_many_namefellows(queue, person_name):
6277
def remove_the_last_person(queue):
6378
"""Remove the person in the last index from the queue and return their name.
6479
65-
:param queue: list - names in the queue.
66-
:return: str - name that has been removed from the end of the queue.
80+
Parameters:
81+
queue (list): The names in the queue.
82+
83+
Returns:
84+
str: The name that has been removed from the end of the queue.
6785
"""
6886

6987
pass
@@ -72,8 +90,11 @@ def remove_the_last_person(queue):
7290
def sorted_names(queue):
7391
"""Sort the names in the queue in alphabetical order and return the result.
7492
75-
:param queue: list - names in the queue.
76-
:return: list - copy of the queue in alphabetical order.
93+
Parameters:
94+
queue (list): The names in the queue.
95+
96+
Returns:
97+
list: A copy of the queue in alphabetical order.
7798
"""
7899

79100
pass

0 commit comments

Comments
 (0)