Bug 582610 - Add usage example to docstring [r=tellrob]
authorMatt Brubeck <mbrubeck@mozilla.com>
Tue, 03 Aug 2010 12:08:20 -0700
changeset 63 14e99b1f1ff9
parent 62 3ba2221f3ca2
child 64 8b9c6e4ff2ab
push id45
push usermbrubeck@mozilla.com
push dateTue, 03 Aug 2010 19:08:44 +0000
reviewerstellrob
bugs582610
Bug 582610 - Add usage example to docstring [r=tellrob]
__init__.py
--- a/__init__.py
+++ b/__init__.py
@@ -1,12 +1,16 @@
 """qimportbz
 
 Imports patches from bugzilla to your mercurial queue
 
+Example:
+
+  hg qimport bz://1234567
+
 Configuration section is entirely optional but potentially useful::
 
   [qimportbz]
   bugzilla = server-address (defaults to BUGZILLA environment varable or bugzilla.mozilla.org)
   joinstr = string to join flags for commit messages (default is ' ')
   patch_format = Formatting string used to create patch names automatically. Set it to empty to use the initial filename.
   msg_format = Formatting string used to create commit messages automatically