diff --git a/exercises/concept/tisbury-treasure-hunt/tuples.py b/exercises/concept/tisbury-treasure-hunt/tuples.py index 92336d88ec1..4bd18224fd2 100644 --- a/exercises/concept/tisbury-treasure-hunt/tuples.py +++ b/exercises/concept/tisbury-treasure-hunt/tuples.py @@ -4,8 +4,11 @@ def get_coordinate(record): """Return coordinate value from a tuple containing the treasure name, and treasure coordinate. - :param record: tuple - with a (treasure, coordinate) pair. - :return: str - the extracted map coordinate. + Parameters: + record (tuple): A (treasure, coordinate) pair. + + Returns: + str: The extracted map coordinate. """ pass @@ -14,8 +17,11 @@ def get_coordinate(record): def convert_coordinate(coordinate): """Split the given coordinate into tuple containing its individual components. - :param coordinate: str - a string map coordinate - :return: tuple - the string coordinate split into its individual components. + Parameters: + coordinate (str): A string map coordinate. + + Returns: + tuple: The string coordinate split into its individual components. """ pass @@ -24,9 +30,12 @@ def convert_coordinate(coordinate): def compare_records(azara_record, rui_record): """Compare two record types and determine if their coordinates match. - :param azara_record: tuple - a (treasure, coordinate) pair. - :param rui_record: tuple - a (location, tuple(coordinate_1, coordinate_2), quadrant) trio. - :return: bool - do the coordinates match? + Parameters: + azara_record (tuple): A (treasure, coordinate) pair. + rui_record (tuple): A (location, tuple(coordinate_1, coordinate_2), quadrant) trio. + + Returns: + bool: Do the coordinates match? """ pass @@ -35,9 +44,12 @@ def compare_records(azara_record, rui_record): def create_record(azara_record, rui_record): """Combine the two record types (if possible) and create a combined record group. - :param azara_record: tuple - a (treasure, coordinate) pair. - :param rui_record: tuple - a (location, coordinate, quadrant) trio. - :return: tuple or str - the combined record (if compatible), or the string "not a match" (if incompatible). + Parameters: + azara_record (tuple): A (treasure, coordinate) pair. + rui_record (tuple): A (location, coordinate, quadrant) trio. + + Returns: + tuple or str: The combined record (if compatible), or the string "not a match" (if incompatible). """ pass @@ -46,12 +58,16 @@ def create_record(azara_record, rui_record): def clean_up(combined_record_group): """Clean up a combined record group into a multi-line string of single records. - :param combined_record_group: tuple - everything from both participants. - :return: str - everything "cleaned", excess coordinates and information are removed. + Parameters: + combined_record_group (tuple): Everything from both participants. + + Returns: + str: Everything "cleaned", excess coordinates and information are removed. - The return statement should be a multi-lined string with items separated by newlines. + Note: + The return statement is a multi-lined string with items separated by newlines. + (see HINTS.md for an example). - (see HINTS.md for an example). """ pass