updated a lot of documentation 😄

arcxon · May 31, 2016 · 297f169 · 297f169
1 parent 30f7153
commit 297f169
Show file tree

Hide file tree

Showing 9 changed files with 65 additions and 15 deletions.
diff --git a/docs/append.rst b/docs/append.rst
@@ -7,11 +7,14 @@ Command
 
 ``append`` or ``a``
 
-
+..  Warning:: You can use this command only when a list is open, use ``open`` to open a list.
 
 Function
 --------
 
+This adds a Todo to the opened list.
 
 Explanation
 -----------
+
+This adds a Todo to the currently _opened_ list. The todo is added to the end/last of the list.
diff --git a/docs/basic-commands.rst b/docs/basic-commands.rst
@@ -11,5 +11,7 @@ There are various Basic commands in the app. These commands are entered with the
     open
     view
     append
+    mark
     search
     delete
+    qdelete
diff --git a/docs/conf.py b/docs/conf.py
@@ -55,7 +55,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.01'
+version = '0.02'
 # The full version, including alpha/beta/rc tags.
 release = 'a'
 

diff --git a/docs/delete.rst b/docs/delete.rst
@@ -11,11 +11,11 @@ Command
 Function
 --------
 
-This deletes
+This deletes the List/Todo/Tag specified
 
 Explanation
 -----------
 
-It shows the currently available lists, that can be opened. Enter the Number/Index in the prompt to open that list.
+It deletes the **Title** , **Todo** or **Tag** specified by the user. It takes input of index and asks confirmation (`yes`/`no`) before deleting.
 
-After Opening other commands like ``append`` and ``view`` can be used on the opened list.
+..  Warning::   This command can not be reversed. After deletion, the data is lost. Please use the command carefully.
diff --git a/docs/entry-modes.rst b/docs/entry-modes.rst
@@ -4,11 +4,11 @@ Entry Modes
 
 The following Entry modes are used throughout the program
 
-=======  ===========================  ==========================
-Prompt   Usual Meaning                Answer Format
-=======  ===========================  ==========================
-``*>``   Basic commands               commands like ``open``
-``+>``   Entry or Input for Content   Sentence or one word
-``#>``   Usually index of Lists etc   Numbers ``0``, ``2`` etc
-``?>``   Question Input               ``yes`` or ``no``
-=======  ===========================  ==========================
+=======  ======  ===========================  ==========================
+Prompt   Color      Usual Meaning                Answer Format
+=======  ======  ===========================  ==========================
+``*>``   yellow  Basic commands               commands like ``open``
+``+>``   green   Entry or Input for Content   Sentence or one word
+``#>``   blue    Usually index of Lists etc   Numbers ``0``, ``2`` etc
+``?>``   red     Question Input               ``yes`` or ``no``
+=======  ======  ===========================  ==========================
diff --git a/docs/mark.rst b/docs/mark.rst
@@ -0,0 +1,20 @@
+====
+Mark
+====
+
+Command
+-------
+
+``mark`` or ``m``
+
+..  Warning:: You can use this command only when a list is open, use ``open`` to open a list.
+
+Function
+--------
+
+This marks status of specified Todo to the input character.
+
+Explanation
+-----------
+
+This modifies the status, (the thing between ``[]``) to the character provided.
diff --git a/docs/qdelete.rst b/docs/qdelete.rst
@@ -0,0 +1,24 @@
+======
+Qdelete
+======
+
+Command
+-------
+
+``qdelete`` or ``qdel``
+
+..  Warning:: You can use this command only when a list is open, use ``open`` to open a list.
+
+Function
+--------
+
+This deletes Todo specified
+
+Explanation
+-----------
+
+Like `delete` but skips the step for asking for **Todo**. Used to **Quickly** (thus qdelete) Delete a Todo.
+
+It deletes the **Todo** specified by the user. It takes input of index and asks confirmation (`yes`/`no`) before deleting.
+
+..  Warning::   This command can not be reversed. After deletion, the data is lost. Please use the command carefully.
diff --git a/docs/view.rst b/docs/view.rst
@@ -16,4 +16,5 @@ View the contents of Opened List.
 
 Explanation
 -----------
-This shows the ToDos that belong to the currently _opened_ list.
+
+This shows the **Title**, **Tags** and **ToDos** that belong to the currently _opened_ list.
diff --git a/main.cpp b/main.cpp
@@ -398,7 +398,7 @@ int main() {
 
     cout << "=== --- --> \033[5;33;1m TodX \033[0;m <-- --- ===" << endl;
     cout << "Welcome to TodX the ultimate Todo list" << endl;
-    cout << "v0.01a = Linux Build, docs at -> http://todx.rtfd.io" << endl;
+    cout << "v0.03a = Linux Build, docs at -> http://todx.rtfd.io" << endl;
 
     char command[80];