Rev 2471: Better docstring for BranchBuilder.__init__. in file:///home/robertc/source/baz/build-branch/

[Robert Collins]

At file:///home/robertc/source/baz/build-branch/

------------------------------------------------------------
revno: 2471
revision-id: robertc at robertcollins.net-20070427023229-0a72vfyt4forz2c5
parent: robertc at robertcollins.net-20070427023143-na837vjyw8y7ulns
committer: Robert Collins <robertc at robertcollins.net>
branch nick: build-branch
timestamp: Fri 2007-04-27 12:32:29 +1000
message:
  Better docstring for BranchBuilder.__init__.
modified:
  bzrlib/branchbuilder.py        branchbuilder.py-20070427022007-zlxpqz2lannhk6y8-1
=== modified file 'bzrlib/branchbuilder.py'
--- a/bzrlib/branchbuilder.py	2007-04-27 02:31:43 +0000
+++ b/bzrlib/branchbuilder.py	2007-04-27 02:32:29 +0000
@@ -23,7 +23,12 @@
     """A BranchBuilder aids creating Branches with particular shapes."""
 
     def __init__(self, transport):
-        """Construct a BranchBuilder on transport."""
+        """Construct a BranchBuilder on transport.
+        
+        :param transport: The transport the branch should be created on.
+            If the path of the transport does not exist but its parent does
+            it will be created.
+        """
         if not transport.has('.'):
             transport.mkdir('.')
         self._branch = bzrdir.BzrDir.create_branch_convenience(transport.base,