Andy Mikhailenko avatar Andy Mikhailenko committed 44a7add

Improve docs for argh.interaction

Comments (0)

Files changed (2)

argh/interaction.py

 
     Usage::
 
-        @arg('key')
-        @arg('--silent', help='do not prompt, always give default answers')
-        def delete(args):
+        def delete(key, silent=False):
             item = db.get(Item, args.key)
-            if confirm('Delete '+item.title, default=True, skip=args.silent):
+            if confirm('Delete '+item.title, default=True, skip=silent):
                 item.delete()
                 print('Item deleted.')
             else:

docs/reference.rst

 .. automodule:: argh.dispatching
    :members:
 
+.. automodule:: argh.interaction
+   :members:
+
 .. automodule:: argh.completion
    :members:
 
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.