Skip to content

[Tuples Concept Exercise]: Updated docstrings in tisbury-treasure-hunt #4148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BethanyG merged 1 commit into from
May 9, 2026
Merged

[Tuples Concept Exercise]: Updated docstrings in tisbury-treasure-hunt #4148

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 30 additions & 14 deletions exercises/concept/tisbury-treasure-hunt/tuples.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Loading