small documentation update
authorAlexander Solovyov <piranha@piranha.org.ua>
Thu, 23 Jul 2009 16:52:29 +0300
changeset 49 a3feac00d151
parent 48 4e7303fd9bec
child 50 ae36fb1b69a2
small documentation update
README
docs/overview.rst
--- a/README	Thu Jul 23 16:51:40 2009 +0300
+++ b/README	Thu Jul 23 16:52:29 2009 +0300
@@ -42,7 +42,10 @@
    -n --nonewline  don't print a newline
    -h --help       show help
 
-I think this mostly describes what's going to. To learn more, read
-`documentation`_.
+I think this mostly describes what's going on, except that I'd like to mention
+one interesting feature - if you are using long name for option, you can use
+only partial name, for example ``./echo.py --nonew`` is valid command line. This
+is also true for subcommands: read about that and everything else you'd like to
+know in `documentation`_.
 
 .. _documentation: http://hg.piranha.org.ua/finaloption/docs/
--- a/docs/overview.rst	Thu Jul 23 16:51:40 2009 +0300
+++ b/docs/overview.rst	Thu Jul 23 16:52:29 2009 +0300
@@ -55,7 +55,8 @@
 function. This is done to comply with standarts of writing both console
 interfaces and Python application.
 
-To make your application work, just call ``main()`` to parse ``sys.argv``.
+To make your application work, just call ``main()`` (it will parse
+``sys.argv``).
 
 Subcommands
 -----------
@@ -108,7 +109,9 @@
   if __name__ == '__main__':
       dispatch(cmdtable=cmdtable)
 
-Example usage, calling ``complex_`` with 5 as argument for ``exit`` option::
+Example usage, calling ``complex_`` with 5 as argument for ``exit`` option,
+showing that command dispatcher will understand partial names of commands and
+options::
 
   app har --ex 5