[Buildbot-devel] [patch] makeApp docstring

[Kevin Turner]

Yay buildbot!  Here, I kinda documented makeApp for you.  There might be
a few holes.  The other thing I wanted a docstring for is the 'prefix'
parameter to FreshCVSSource.

Thanks,

 - Kevin
-------------- next part --------------
--- buildbot-0.3.3/buildbot/master.py	2003-05-21 15:19:32.000000000 -0700
+++ buildbot-0.3.3.new/buildbot/master.py	2003-07-26 12:19:57.000000000 -0700
@@ -211,18 +211,36 @@
 def makeApp(bots, basedir, sources, builders,
             port=8007, webServerPort=8080, webServerPath=None,
             enableDebug=0, enableManhole=0):
+    """Construct a buildmaster Application.
+
+    @param bots: Names and passwords of the build slaves.
+    @type bots: list of (name, password) strings.
+    @param basedir: My working directory.
+    @type basedir: string
+    @param sources: Sources of build notification.
+    @type sources: list of XXX
+    @param builders: The builds I will run.
+    @type builders: list of L{buildbot.process.base.Builder}s
+
+    @param enableDebug: Create a L{DebugService}?
+    @type enableDebug: bool
+    @param enableManhole: Create a Manhole?
+    @type enableManhole: bool
+
+    @returntype: Application
+    """
 
     from buildbot.master import BotMaster, DebugService
     from buildbot.changes.changes import ChangeMaster
     from buildbot.status.client import StatusClientService
-    
+
     app = Application("buildmaster")
     app.basedir = basedir
-    
+
     auth = DefaultAuthorizer(app)
 
     bot_svc = BotMaster("botmaster", app, auth)
-    
+
     # create a separate Identity for each buildbot slave
     for (name, pw) in bots:
         bot_id = auth.createIdentity(name)