small docs update
authorAlexander Solovyov <alexander@solovyov.net>
Mon, 15 Nov 2010 14:56:57 +0100
changeset 135 444518c54a66
parent 134 43702c4c4139
child 136 57444e973879
small docs update
README
docs/overview.rst
--- a/README	Mon Nov 15 14:48:13 2010 +0100
+++ b/README	Mon Nov 15 14:56:57 2010 +0100
@@ -53,4 +53,4 @@
 `documentation`_.
 
 .. _documentation: http://hg.piranha.org.ua/opster/docs/
-.. _see description: http://hg.piranha.org.ua/opster/docs/overview.html
+.. _see description: http://hg.piranha.org.ua/opster/docs/overview.html#options-processing
--- a/docs/overview.rst	Mon Nov 15 14:48:13 2010 +0100
+++ b/docs/overview.rst	Mon Nov 15 14:56:57 2010 +0100
@@ -1,6 +1,6 @@
-===================
+==============
  Opster usage
-===================
+==============
 
 Options
 -------
@@ -12,6 +12,9 @@
           ('d', 'daemonize', False, 'daemonize process'),
           ('', 'pid-file', '', 'name of file to write process ID to')]
 
+Options contents
+^^^^^^^^^^^^^^^^
+
 Each tuple is a definition of some option, consisting of 4 elements:
 
  1. short name
@@ -20,14 +23,21 @@
  4. help string
 
 If a short name renders to False (for example, empty string), then it's not used
-at all. Long name is pretended to be available in any case. Default value also
-determines how supplied argument should be parsed:
+at all. Long name is pretended to be available in any case.
+
+Options processing
+^^^^^^^^^^^^^^^^^^
+
+Default value also determines how supplied argument should be parsed:
 
  - function: return value of function called with a specified value is passed
  - integer: value is convert to integer
  - string: value is passed as is
  - list: value is appended to this list
- - boolean/None: ``not default`` is passed and option takes no argument
+ - boolean/None: ``not default`` is passed and option takes no value
+
+Usage
+^^^^^
 
 Usage is easy like that::