Added status command in the docs 📖

arcxon · Jun 1, 2016 · 81e282d · 81e282d
1 parent ac429ca
commit 81e282d
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 3 deletions.
diff --git a/docs/basic-commands.rst b/docs/basic-commands.rst
@@ -9,6 +9,7 @@ There are various Basic commands in the app. These commands are entered with the
 
     new
     open
+    status
     view
     append
     mark

diff --git a/docs/conf.py b/docs/conf.py
@@ -270,7 +270,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'TodX', 'TodX Documentation',
-     author, 'TodX', 'One line description of project.',
+     author, 'TodX', 'The Cool Todo app',
      'Miscellaneous'),
 ]
 

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -4,9 +4,9 @@ Quick Start
 
 TodX is a great Todo app. But you need to first learn a tool to use it. Learn it below.
 
-For installation, refer to the `install instructions_`
+For installation, refer to the `install instructions`_
 
-:ref: `install`
+.. _install instructions:: Installation
 
 Basic Commands
 --------------

diff --git a/docs/status.rst b/docs/status.rst
@@ -0,0 +1,18 @@
+======
+Status
+======
+
+Command
+-------
+
+``status`` or ``stat``
+
+Function
+--------
+
+Tells if a list is open or not.
+
+Explanation
+-----------
+
+Tells wether a list is _opened_ or not. Useful before executing commands like ``append`` and ``qdelete``.