More clearly document actions
John Smith commited on 2022-358 13:24:31
Showing 1 changed files, with 4 additions and 4 deletions.
The help option now includes, in the description of each action for which this applies, a note about what extra input Memoire expects in order to run the action.
- actions.lua 4092a88..90d6bf6
| ... | ... |
@@ -143,7 +143,7 @@ end |
| 143 | 143 |
|
| 144 | 144 |
local actions = {
|
| 145 | 145 |
a = {
|
| 146 |
- desc = "(a)dd card", |
|
| 146 |
+ desc = "(a)dd card (from stdin)", |
|
| 147 | 147 |
nd = true, |
| 148 | 148 |
fn = function(config, deck) |
| 149 | 149 |
if isatty() then |
| ... | ... |
@@ -174,7 +174,7 @@ local actions = {
|
| 174 | 174 |
}, |
| 175 | 175 |
|
| 176 | 176 |
c = {
|
| 177 |
- desc = "(c)orrect card", |
|
| 177 |
+ desc = "(c)orrect card (with card:prompt index)", |
|
| 178 | 178 |
nd = true, |
| 179 | 179 |
ni = true, |
| 180 | 180 |
fn = function(config, deck, _, ip) |
| ... | ... |
@@ -331,7 +331,7 @@ local actions = {
|
| 331 | 331 |
}, |
| 332 | 332 |
|
| 333 | 333 |
s = {
|
| 334 |
- desc = "(s)tatistics", |
|
| 334 |
+ desc = "(s)tatistics (with optional query)", |
|
| 335 | 335 |
nd = true, |
| 336 | 336 |
nq = true, |
| 337 | 337 |
fn = function(config, deck, deckfname, qs) |
| ... | ... |
@@ -423,7 +423,7 @@ local actions = {
|
| 423 | 423 |
}, |
| 424 | 424 |
|
| 425 | 425 |
t = {
|
| 426 |
- desc = "(t)oggle suspension of prompt", |
|
| 426 |
+ desc = "(t)oggle suspension of prompt (with card:prompt index)", |
|
| 427 | 427 |
nd = true, |
| 428 | 428 |
ni = true, |
| 429 | 429 |
fn = function(config, deck, _, ip) |
| 430 | 430 |