Add more useful help test
authorNeil <neil@dip.sun.ac.za>
Sat, 17 Nov 2012 15:37:56 +0000 (17:37 +0200)
committerNeil <neil@dip.sun.ac.za>
Sat, 17 Nov 2012 15:37:56 +0000 (17:37 +0200)
__init__.py

index 26d45a2cd80aeb200bf7c8fd2bfbb04bff9da88d..bae47ea3e9e7b898d458a7ff20b761de3df4631b 100644 (file)
@@ -4,7 +4,14 @@
 # GPL 2+ - see COPYING for details
 """Sending irker notifications for commits and branch changes.
 
-Details to follow
+This will talk to an irkerd (currently assumed to be running on localhost)
+and post commit logs.
+
+Useful configuration settings:
+    irker_project - The name of the project used in announcements
+    irker_channels - The irc channels to post announcements to
+    irker_colours - Settings for using colours in the announcements (ANSI or
+        mIRC)
 """
 
 from bzrlib.config import option_registry
@@ -17,7 +24,6 @@ from bzrlib.plugins.bzrirker import irkerhook as _irkerhook
 """)
 
 
-
 def branch_commit_hook(local, master, old_revno, old_revid,
         new_revno, new_revid):
     """This is the post_commit hook that runs after commit."""