Documentation

- Corrected command usages.
- Corrected help command output.
This commit is contained in:
Paul Beckingham 2012-03-06 00:36:37 -05:00
parent 2ab2497126
commit 8537ddbb5a
5 changed files with 13 additions and 8 deletions

View file

@ -44,7 +44,7 @@ extern Context context;
CmdCalendar::CmdCalendar ()
{
_keyword = "calendar";
_usage = "task calendar [due|month year|year]";
_usage = "task calendar [due|<month> <year>|<year>] [y]";
_description = STRING_CMD_CAL_USAGE;
_read_only = true;
_displays_id = true;

View file

@ -43,7 +43,7 @@ extern Context context;
CmdMerge::CmdMerge ()
{
_keyword = "merge";
_usage = "task merge URL";
_usage = "task merge <URL>";
_description = STRING_CMD_MERGE_USAGE;
_read_only = false;
_displays_id = false;

View file

@ -42,7 +42,7 @@ extern Context context;
CmdPull::CmdPull ()
{
_keyword = "pull";
_usage = "task pull URL";
_usage = "task pull <URL>";
_description = STRING_CMD_PULL_USAGE;
_read_only = true;
_displays_id = false;

View file

@ -42,7 +42,7 @@ extern Context context;
CmdPush::CmdPush ()
{
_keyword = "push";
_usage = "task push URL";
_usage = "task push <URL>";
_description = STRING_CMD_PUSH_USAGE;
_read_only = true;
_displays_id = false;

View file

@ -833,7 +833,7 @@
"http://taskwarrior.org\n" \
"\n" \
"The general form of commands is:\n" \
" task <filter> <command> <mods>\n" \
" task [<filter>] <command> [<mods>]\n" \
"\n" \
"The <filter> consists of zero or more restrictions on which tasks to select, " \
"such as:\n" \
@ -895,9 +895,6 @@
"Alternately algebraic expressions support:\n" \
" and or xor Logical operators\n" \
" < <= = != >= > Relational operators\n" \
" + - Addition, subtraction\n" \
" ! Inversion\n" \
" ~ !~ Match, no match\n" \
" ( ) Precedence\n" \
"\n" \
" task due.before:eom priority.not:L list\n" \
@ -927,6 +924,14 @@
" $ ! ' \" ( ) ; \\ ` * ? { } [ ] < > | & % # ~\n" \
"\n"
/*
To be included later, before the 'precendence' line.
" + - Addition, subtraction\n" \
" ! Inversion\n" \
" ~ !~ Match, no match\n" \
*/
// util
#define STRING_UTIL_CONFIRM_YN " (yes/no) "
#define STRING_UTIL_CONFIRM_YES "yes"