- database. The return value can be used in a Slack command
- expecting blocks to provide all the details of a hunt, (puzzles,
- their state, solution, links to channels and sheets, etc.).
+ database.
+
+ Three optional arguments can be used to filter which puzzles to
+ include in the result:
+
+ puzzle_status: If either 'solved' or 'unsolved' only puzzles
+ with that status will be included in the
+ result. If any other value, all puzzles in the
+ hunt will be considered.
+
+ search_terms: A list of search terms. Only puzzles that match
+ all of these terms will be included in the
+ result. A match will be considered on any of
+ puzzle title, round title, puzzle URL, puzzle
+ state, puzzle type, tags, or solution
+ string. Terms can include regular expression
+ syntax.
+
+ limit_to_rounds: A list of rounds. If provided only the given
+ rounds will be included in the output. Note:
+ an empty list means to display only puzzles
+ assigned to no rounds, while an argument of
+ None means to display all puzzles with no
+ limit on the rounds.
+
+ The return value can be used in a Slack command expecting blocks to
+ provide all the details of a hunt, (puzzles, their state,
+ solution, links to channels and sheets, etc.).
+