[trivial][merge] fix doc on DirState.initialize

[John Arbash Meinel]

Martin Pool wrote:
> While looking at the dirstate locking stuff:
> 
> === modified file 'bzrlib/dirstate.py'
> --- bzrlib/dirstate.py  2007-04-01 01:38:25 +0000
> +++ bzrlib/dirstate.py  2007-04-19 13:28:56 +0000
> @@ -1407,12 +1407,8 @@
>         The new dirstate will be an empty tree - that is it has no parents,
>         and only a root node - which has id ROOT_ID.
> 
> -        The object will be write locked when returned to the caller,
> -        unless there was an exception in the writing, in which case it
> -        will be unlocked.
> -
>         :param path: The name of the file for the dirstate.
> -        :return: A DirState object.
> +        :return: A write-locked DirState object.
>         """
>         # This constructs a new DirState object on a path, sets the
> _state_file
>         # to a new empty file for that path. It then calls _set_data()
> with our
> 
> It looks like this function doesn't return a DirState at all if
> there's a failure, which is as it should be.  Or did I miss something?
> 

+1, though the indenting looks wrong.

John
=:->