From: Carl Worth <cworth@cworth.org>
Date: Fri, 7 Jan 2022 03:24:18 +0000 (-0800)
Subject: Edit the help messages for "new" and "edit"
X-Git-Url: https://git.cworth.org/git?p=turbot;a=commitdiff_plain;h=aa9d2122da30b7c78fce747d10ac8a68767e0429

Edit the help messages for "new" and "edit"

The old help messages were confusing. It wasn't always clear that
"[puzzle]" meant an optional argument of literally the word "puzzle"
rather than the name of a particular puzzle to edit.

Instead, we encourage people to use these commands without arguments
(whenever possible, such as "/edit" for hunt or puzzle and "/new" for
puzzle) and to use clear literal arguments when necessary (such as
"/new hunt" from any channel or "/edit hunt" from within a puzzle
channel).
---

diff --git a/turbot/help.py b/turbot/help.py
index 9a4d9fd..9c76772 100644
--- a/turbot/help.py
+++ b/turbot/help.py
@@ -9,12 +9,13 @@ as `/solved SOLUTION`).
 Type `/help <command-name>` for more details on any command below.
 
 *Hunt creation and editing*
-    `/new [hunt]`: Create a new hunt (from any channel)
-    `/edit [hunt]`: Edit the current hunt (in a hunt or puzzle channel)
+    `/new hunt`: Create a new hunt (from any channel)
+    `/edit`: Edit the current hunt (from a hunt channel)
+    `/edit hunt`: Edit the current hunt (from a puzzle channel)
 
 *Puzzle creation and editing* (in a puzzle channel unless specified)
-    `/new [puzzle]`: Create a new puzzle (in a hunt or puzzle channel)
-    `/edit [puzzle]`: Edit the current puzzle
+    `/new`: Create a new puzzle (in a hunt or puzzle channel)
+    `/edit`: Edit the current puzzle (from a puzzle channel)
     `/state <update>`: Capture the current state
     `/solved <solution>`: Mark current puzzle solved
     `/tag [+ADD_TAG|-REMOVE_TAG]`: Tag/untag current puzzle