Added docstrings to exemplars and stubs. Changed some exemplar code to conform to Pylint nags.

BethanyG · BethanyG · commit fd9b7bf33677 · 2021-09-01T03:43:53.000-07:00
diff --git a/exercises/concept/making-the-grade/.meta/exemplar.py b/exercises/concept/making-the-grade/.meta/exemplar.py
@@ -1,11 +1,21 @@
 def round_scores(student_scores):
+    '''
+    :param student_scores: list of student exam scores as float or int.
+    :return: list of student scores *rounded* to nearest integer value.
+    '''
+
     rounded = []
     while student_scores:
         rounded.append(round(student_scores.pop()))
     return rounded
 
 
 def count_failed_students(student_scores):
+    '''
+    :param student_scores: list of integer student scores.
+    :return: integer count of student scores at or below 40.
+    '''
+
     non_passing = 0
     for score in student_scores:
         if score <= 40:
@@ -14,14 +24,26 @@ def count_failed_students(student_scores):
 
 
 def above_threshold(student_scores, threshold):
-    above_threshold = []
+    '''
+    :param student_scores: list of integer scores
+    :param threshold :  integer
+    :return: list of integer scores that are at or above the "best" threshold.
+    '''
+
+    above = []
+
     for score in student_scores:
         if score >= threshold:
-            above_threshold.append(score)
-    return above_threshold
+            above.append(score)
+    return above
 
 
 def letter_grades(highest):
+    '''
+   :param highest: integer of highest exam score.
+   :return: list of integer score thresholds for each F-A letter grades.
+   '''
+
     increment = round((highest - 40)/4)
     scores = []
     for score in range(41, highest, increment):
@@ -30,20 +52,31 @@ def letter_grades(highest):
 
 
 def student_ranking(student_scores, student_names):
+    '''
+     :param student_scores: list of scores in descending order.
+     :param student_names: list of names in descending order by exam score.
+     :return: list of strings in format ["<rank>. <student name>: <score>"].
+     '''
+
     results = []
     for index, name in enumerate(student_names):
         rank_string = str(index + 1) + ". " + name + ": " + str(student_scores[index])
         results.append(rank_string)
-        #results.append(f"{index + 1}. {name}: {student_scores[index]}")
+
     return results
 
 
 def perfect_score(student_info):
+    '''
+    :param student_info: list of [<student name>, <score>] lists
+    :return: First [<student name>, 100] found OR "No perfect score."
+    '''
+
     result = "No perfect score."
+
     for item in student_info:
         if item[1] == 100:
             result = item
             break
-        else:
-            continue
+
     return result
diff --git a/exercises/concept/making-the-grade/loops.py b/exercises/concept/making-the-grade/loops.py
@@ -3,13 +3,15 @@ def round_scores(student_scores):
     :param student_scores: list of student exam scores as float or int.
     :return: list of student scores *rounded* to nearest integer value.
     '''
+
     pass
 
 def count_failed_students(student_scores):
     '''
     :param student_scores: list of integer student scores.
     :return: integer count of student scores at or below 40.
     '''
+
     pass
 
 def above_threshold(student_scores, threshold):
@@ -18,21 +20,26 @@ def above_threshold(student_scores, threshold):
     :param threshold :  integer
     :return: list of integer scores that are at or above the "best" threshold.
     '''
+
     pass
 
 def letter_grades(highest):
     '''
     :param highest: integer of highest exam score.
     :return: list of integer score thresholds for each F-A letter grades.
     '''
+
     pass
+
 def student_ranking(student_scores, student_names):
     '''
      :param student_scores: list of scores in descending order.
      :param student_names: list of names in descending order by exam score.
      :return: list of strings in format ["<rank>. <student name>: <score>"].
      '''
+
     pass
+
 def perfect_score(student_info):
     '''
     :param student_info: list of [<student name>, <score>] lists
diff --git a/exercises/concept/restaurant-rozalynn/.meta/exemplar.py b/exercises/concept/restaurant-rozalynn/.meta/exemplar.py
@@ -1,43 +1,87 @@
+
 def new_seating_chart(size=22):
-    seats = dict()
-    for number in range(1, size+1):
-        seats[number] = None
-    return seats
+    '''
+
+    :param size: int - number if seats in the seating chart.
+    :return: dict - with number of seats specified, and placeholder values.
+    '''
+
+    return {number: None for number in range(1, size+1) }
+
 
 def arrange_reservations(guests=None):
-    if guests is None:
-        return new_seating_chart()
-    else:
-        seats = new_seating_chart()
+    '''
+
+    :param guest_list: list - list of guest names for reservations.
+    :return: dict - Default sized dictionary with guests assigned seats,
+             and placeholders for empty seats.
+    '''
+
+    seats = new_seating_chart()
+
+    if guests:
         for seat_number in range(1, len(guests)):
             seats[seat_number] = guests[seat_number]
     return seats
 
+
 def find_all_available_seats(seats):
+    '''
+
+    :param seats: dict - seating chart.
+    :return: list - list of seat numbers available for reserving..
+    '''
+
     available = []
     for seat_num, value in seats.items():
         if value is None:
             available.append(seat_num)
     return available
 
+
 def curr_empty_seat_capacity(seats):
+    '''
+
+    :param seats: dict - dictionary of reserved seats.
+    :return: int - number of seats empty.
+    '''
+
     count = 0
     for value in seats.values():
         if value is None:
             count += 1
     return count
 
+
 def accommodate_waiting_guests(seats, guests):
+    '''
+
+    :param seats: dict - seating chart dictionary.
+    :param guests: list - walk-in guests
+    :return: dict - updated seating chart with available spaces filled.
+    '''
+
     curr_empty_seats = curr_empty_seat_capacity(seats)
     empty_seat_list = find_all_available_seats(seats)
+
     if len(guests) > curr_empty_seats:
         return False
     else:
-        for index in range(len(guests)):
+        for index, item in enumerate(guests):
             seats[empty_seat_list[index]] = guests[index]
+
     return seats
 
+
 def empty_seats(seats, seat_numbers):
-   for seat in seat_numbers:
-      seats[seat] = None
-   return seats
+    '''
+
+    :param seats: dict - seating chart dictionary.
+    :param seat_numbers: list - list of seat numbers to free up or empty.
+    :return: updated seating chart dictionary.
+    '''
+
+    for seat in seat_numbers:
+        seats[seat] = None
+
+    return seats
diff --git a/exercises/concept/restaurant-rozalynn/none.py b/exercises/concept/restaurant-rozalynn/none.py
@@ -1,16 +1,57 @@
-def new_seating_chart():
+def new_seating_chart(size=22):
+    '''
+
+    :param size: int - number if seats in the seating chart. Default is 22.
+    :return: dict - with number of seats specified, and placeholder values.
+    '''
+
+    pass
+
+def arrange_reservations(guest_list):
+    '''
+
+    :param guest_list: list - list of guest names for reservations.
+    :return: dict - Default sized dictionary with guests assigned seats,
+             and placeholders for empty seats.
+    '''
+
+    pass
+
+def find_all_available_seats(seats):
+    '''
+
+    :param seats: dict - seating chart.
+    :return: list - list of seat numbers available for reserving..
+    '''
+
     pass
 
-def arrange_reservations():
+def current_seating_capacity(seats):
+    '''
+
+    :param seats: dict - dictionary of reserved seats.
+    :return: int - number of seats empty.
+    '''
+
     pass
 
-def find_all_available_seats():
-   pass
+def accommodate_waiting_guests(seats, guests):
+    '''
 
-def current_seating_capacity():
-   pass
+    :param seats: dict - seating chart dictionary.
+    :param guests: list - walk-in guests
+    :return: dict - updated seating chart with available spaces filled.
+    '''
 
-def accommodate_waiting_guests():
-   pass
-def empty_seats():
     pass
+
+
+def empty_seats(seats, seat_numbers):
+    '''
+
+    :param seats: dict - seating chart dictionary.
+    :param seat_numbers: list - list of seat numbers to free up or empty.
+    :return: updated seating chart dictionary.
+    '''
+
+    pass
diff --git a/exercises/concept/tisbury-treasure-hunt/.meta/exemplar.py b/exercises/concept/tisbury-treasure-hunt/.meta/exemplar.py
@@ -1,21 +1,58 @@
 def get_coordinate(record):
+    '''
+
+    :param record: tuple - a (treasure, coordinate) pair.
+    :return: str - the extracted map coordinate.
+    '''
+
     return record[1]
 
+
 def convert_coordinate(coordinate):
+    '''
+
+    :param coordinate: str - a string map coordinate
+    :return:  tuple - the string coordinate seperated into its individual components.
+    '''
+
     return tuple(coordinate)
 
+
 def compare_records(azara_record, rui_record):
+    '''
+
+    :param azara_record: tuple - a (treasure, coordinate) pair.
+    :param rui_record: tuple - a (location, coordinate, quadrant) trio.
+    :return: bool - True if coordinates match, False otherwise.
+    '''
+
     return convert_coordinate(azara_record[1]) in rui_record
 
+
 def create_record(azara_record, rui_record):
+    '''
+
+    :param azara_record: tuple - a (treasure, coordinate) pair.
+    :param rui_record: tuple - a (location, coordinate, quadrant) trio.
+    :return:  tuple - combined record, or "not a match" if the records are incompatible.
+    '''
+
     if compare_records(azara_record, rui_record):
         return azara_record + rui_record
     else:
         return "not a match"
 
+
 def clean_up(combined_record_group):
+    '''
+
+    :param combined_record_group: tuple of tuples - everything from both participants.
+    :return: tuple of tuples - everything "cleaned", with excess coordinates and information removed.
+    '''
 
     report = ""
+
     for item in combined_record_group:
-       report += f"{(item[0], item[2], item[3], item[4])}\n"
+        report += f"{(item[0], item[2], item[3], item[4])}\n"
+
     return report
diff --git a/exercises/concept/tisbury-treasure-hunt/tuples.py b/exercises/concept/tisbury-treasure-hunt/tuples.py
