Andy Mikhailenko avatar Andy Mikhailenko committed 8bce6f1

Fixed errors in documentation.

Comments (0)

Files changed (2)

 
 A very simple application with one command::
 
-    @arg('text')  # signature is same as ArgumentParser.add_argument
-    def echo(args):
-        print args.text
-    
+    @command
+    def echo(text='hello'):
+        print text
+   
     parser = ArghParser()
     parser.add_commands([echo])
 
     if __name__ == '__main__':
         parser.dispatch()
 
+The powerful API of `argparse` is also available::
+
+    @arg('text', default='hello world', nargs='+', help='The message')
+    def echo(args):
+        print args.text
+
+The approaches can be safely combined.
+
 Documentation
 -------------
 

docs/tutorial.rst

 Dive in
 -------
 
-Defining commands is dead simple::
+Defining and running commands is dead simple::
 
     from argh import *
     
     def load(path, format='json'):
         print loaders[format].load(path)
 
-    argh.dispatch()
+    p = ArghParser()
+    p.add_commands([load])
+    p.dispatch()
 
 And then call your script like this::
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.