Merge lp:~parthm/bzr/trivial-doc-followup-549310-mandatory-whoami into lp:bzr

[Parth Malwankar]

(parthm) trivial docstring fix to indicate when errors.NoWhoami is raised.

Yesterday, on IRC vila noticed that some docstrings were out of date for the patch
https://code.launchpad.net/~parthm/bzr/549310-mandatory-whoami/+merge/24244

This is a trivial docstring update patch to fix that.

[Vincent Ladeuil (vila)]

Thanks !

review: Approve

[Robert Collins (lifeless)]

rather than 'if none is found' perhaps 'if no username can be found' - a little clearer.

[Parth Malwankar (parthm)]

> rather than 'if none is found' perhaps 'if no username can be found' - a
> little clearer.

Done. Thanks.

[lp:~parthm/bzr/trivial-doc-followup-549310-mandatory-whoami]

5199. By Parth Malwankar on 2010-05-07

trivial clarification in docstring.

=== modified file 'bzrlib/config.py'
--- bzrlib/config.py	2010-04-28 04:52:16 +0000
+++ bzrlib/config.py	2010-05-07 06:40:50 +0000
@@ -260,8 +260,7 @@
         $BZR_EMAIL can be set to override this, then
         the concrete policy type is checked, and finally
         $EMAIL is examined.
-        If none is found, a reasonable default is (hopefully)
-        created.
+        If no username can be found, errors.NoWhoami exception is raised.
 
         TODO: Check it's reasonably well-formed.
         """
@@ -280,7 +279,7 @@
         raise errors.NoWhoami()
 
     def ensure_username(self):
-        """Raise BzrCommandError if username is not set.
+        """Raise errors.NoWhoami if username is not set.
 
         This method relies on the username() function raising the error.
         """