Improved usage messages for actions (#402)

Co-authored-by: Ingo Karkat <[email protected]>

Author: chrysle

README.md

@@ -74,10 +74,10 @@ For example, to add a todo item, you can do:
 todo.sh add "THING I NEED TO DO +project @context"
 ```
 ### `replace`
-Replaces task on line ITEM# with UPDATED TODO.
+Replaces task on line NR with UPDATED TODO.
 
 ```shell
-todo.sh replace ITEM# "UPDATED TODO"
+todo.sh replace NR "UPDATED TODO"
 ```
 ### `report`
 Adds the number of open tasks and done tasks to report.txt.

USAGE.md

@@ -38,13 +38,13 @@ todo.sh addto DEST "TEXT TO ADD"
 ```
 
 ### `append`
-Adds TEXT TO APPEND to the end of the task on line ITEM#.
+Adds TEXT TO APPEND to the end of the task on line NR.
 
 Quotes optional.
 
 ```shell
-todo.sh append ITEM# "TEXT TO APPEND"
-todo.sh app ITEM# "TEXT TO APPEND"
+todo.sh append NR "TEXT TO APPEND"
+todo.sh app NR "TEXT TO APPEND"
 ```
 
 ### `archive`
@@ -71,26 +71,26 @@ todo.sh deduplicate
 ```
 
 ### `del`
-Deletes the task on line ITEM# in todo.txt. If TERM specified, deletes only TERM from the task.
+Deletes the task on line NR in todo.txt. If TERM specified, deletes only TERM from the task.
 
 ```shell
-todo.sh del ITEM# [TERM]
-todo.sh rm ITEM# [TERM]
+todo.sh del NR [TERM]
+todo.sh rm NR [TERM]
 ```
 
 ### `depri`
-Deprioritizes (removes the priority) from the task(s) on line ITEM# in todo.txt.
+Deprioritizes (removes the priority) from the task(s) on line NR in todo.txt.
 
 ```shell
-todo.sh depri ITEM#[, ITEM#, ITEM#, ...]
-todo.sh dp ITEM#[, ITEM#, ITEM#, ...]
+todo.sh depri NR [NR ...]
+todo.sh dp NR [NR ...]
 ```
 
 ### `do`
-Marks task(s) on line ITEM# as done in todo.txt.
+Marks task(s) on line NR as done in todo.txt.
 
 ```shell
-todo.sh do ITEM#[, ITEM#, ITEM#, ...]
+todo.sh do NR [NR ...]
 ```
 
 ### `help`
@@ -164,34 +164,34 @@ todo.sh lsprj [TERM...]
 ```
 
 ### `move`
-Moves a line from source text file (SRC) to destination text file (DEST). Both source and destination file must be located in the directory defined in the configuration directory. When SRC is not defined it's by default todo.txt.
+Moves line NR from source text file (SRC) to destination text file (DEST). Both source and destination file must be located in the directory defined in the configuration directory. When SRC is not defined it's by default todo.txt.
 
 ```shell
-todo.sh move ITEM# DEST [SRC]
-todo.sh mv ITEM# DEST [SRC]
+todo.sh move NR DEST [SRC]
+todo.sh mv NR DEST [SRC]
 ```
 
 ### `prepend`
-Adds TEXT TO PREPEND to the beginning of the task on line ITEM#. Quotes optional.
+Adds TEXT TO PREPEND to the beginning of the task on line NR. Quotes optional.
 
 ```shell
-todo.sh prepend ITEM# "TEXT TO PREPEND"
-todo.sh prep ITEM# "TEXT TO PREPEND"
+todo.sh prepend NR "TEXT TO PREPEND"
+todo.sh prep NR"TEXT TO PREPEND"
 ```
 
 ### `pri`
-Adds PRIORITY to task on line ITEM#.  If the task is already prioritized, replaces current priority with new PRIORITY. PRIORITY must be a letter between A and Z.
+Adds PRIORITY to task on line NR.  If the task is already prioritized, replaces current priority with new PRIORITY. PRIORITY must be a letter between A and Z.
 
 ```shell
-todo.sh pri ITEM# PRIORITY
-todo.sh p ITEM# PRIORITY
+todo.sh pri NR PRIORITY
+todo.sh p NR PRIORITY
 ```
 
 ### `replace`
-Replaces task on line ITEM# with UPDATED TODO.
+Replaces task on line NR with UPDATED TODO.
 
 ```shell
-todo.sh replace ITEM# "UPDATED TODO"
+todo.sh replace NR "UPDATED TODO"
 ```
 
 ### `report`

tests/actions-test-lib.sh

@@ -6,7 +6,7 @@ make_dummy_action()
     cat > "$1" <<EOF
 #!/bin/bash
 [ "\$1" = "usage" ] && {
-    echo "    $actionName ITEM#[, ITEM#, ...] [TERM...]"
+    echo "    $actionName NR [NR ...] [TERM...]"
     echo "      This custom action does $actionName."
     echo ""
     exit

tests/t1100-replace.sh

@@ -14,7 +14,7 @@ todo.sh add notice the daisies > /dev/null
 test_todo_session 'replace usage' <<EOF
 >>> todo.sh replace adf asdfa
 === 1
-usage: todo.sh replace ITEM# "UPDATED ITEM"
+usage: todo.sh replace NR "UPDATED ITEM"
 EOF
 
 test_todo_session 'basic replace' <<EOF

tests/t1200-pri.sh

@@ -6,7 +6,7 @@ test_description='basic priority functionality
 
 test_todo_session 'priority usage' <<EOF
 >>> todo.sh pri B B
-usage: todo.sh pri ITEM# PRIORITY[, ITEM# PRIORITY, ...]
+usage: todo.sh pri NR PRIORITY [NR PRIORITY ...]
 note: PRIORITY must be anywhere from A to Z.
 === 1
 EOF

tests/t1400-prepend.sh

@@ -6,7 +6,7 @@ test_description='basic prepend functionality
 
 test_todo_session 'prepend usage' <<EOF
 >>> todo.sh prepend B B
-usage: todo.sh prepend ITEM# "TEXT TO PREPEND"
+usage: todo.sh prepend NR "TEXT TO PREPEND"
 === 1
 EOF
 

tests/t1500-do.sh

@@ -8,13 +8,13 @@ test_description='do functionality
 
 test_todo_session 'do usage' <<EOF
 >>> todo.sh do B B
-usage: todo.sh do ITEM#[, ITEM#, ITEM#, ...]
+usage: todo.sh do NR [NR ...]
 === 1
 EOF
 
-test_todo_session 'do missing ITEM#' <<EOF
+test_todo_session 'do missing NR' <<EOF
 >>> todo.sh do
-usage: todo.sh do ITEM#[, ITEM#, ITEM#, ...]
+usage: todo.sh do NR [NR ...]
 === 1
 EOF
 

tests/t1600-append.sh

@@ -14,7 +14,7 @@ todo.sh add notice the daisies > /dev/null
 test_todo_session 'append usage' <<EOF
 >>> todo.sh append adf asdfa
 === 1
-usage: todo.sh append ITEM# "TEXT TO APPEND"
+usage: todo.sh append NR "TEXT TO APPEND"
 EOF
 
 test_todo_session 'append error' <<EOF

tests/t1700-depri.sh

@@ -6,7 +6,7 @@ test_description='basic depriority functionality
 
 test_todo_session 'depriority usage' <<EOF
 >>> todo.sh depri B B
-usage: todo.sh depri ITEM#[, ITEM#, ITEM#, ...]
+usage: todo.sh depri NR [NR ...]
 === 1
 EOF
 

tests/t1800-del.sh

@@ -8,7 +8,7 @@ SPACE=' '
 
 test_todo_session 'del usage' <<EOF
 >>> todo.sh del B
-usage: todo.sh del ITEM# [TERM]
+usage: todo.sh del NR [TERM]
 === 1
 EOF