From: Carl Worth <cworth@cworth.org>
Date: Tue, 12 Jan 2021 01:52:40 +0000 (-0800)
Subject: Fix comment string for find_puzzle_for_sort_key
X-Git-Url: https://git.cworth.org/git?p=turbot;a=commitdiff_plain;h=d53959afec8688d3f3c164f1b94de6dbec8bc13c

Fix comment string for find_puzzle_for_sort_key

The documentation here was stale and still referring to puzzle_id even
though this function is actually using sort_key, (which is similar but
is also slightly different).
---

diff --git a/turbot/puzzle.py b/turbot/puzzle.py
index 08e8621..3a0e312 100644
--- a/turbot/puzzle.py
+++ b/turbot/puzzle.py
@@ -7,11 +7,18 @@ import turbot.sheets
 import re
 
 def find_puzzle_for_sort_key(turb, hunt_id, sort_key):
-    """Given a hunt_id and puzzle_id, return that puzzle
+    """Given a hunt_id and sort_key, return that puzzle
 
-    Returns None if no puzzle with the given hunt_id and puzzle_id
+    Returns None if no puzzle with the given hunt_id and sort_key
     exists in the database, otherwise a dictionary with all fields
     from the puzzle's row in the database.
+
+    Note: The sort_key is a modified version of the puzzle_id, (used
+    to make metapuzzles appear in the ordering before non-metapuzzles).
+    If you've been handed a sort_key, then looking up a puzzle by
+    sort_key is the right thing to do. But if you instead have just
+    a puzzle_id, see find_puzzle_for_puzzle_id rather than trying
+    to convert the puzzle_id into a sort_key to use this function.
     """
 
     response = turb.table.get_item(