Rev 2402: Document BzrDir.open_workingtree's new recommend_upgrade parameter. in file:///home/robertc/source/baz/misc-fixen/

[Robert Collins]

At file:///home/robertc/source/baz/misc-fixen/

------------------------------------------------------------
revno: 2402
revision-id: robertc at robertcollins.net-20070405084449-xmkv95pa4cgn0het
parent: robertc at robertcollins.net-20070405030706-9zpyygdfimm020u8
committer: Robert Collins <robertc at robertcollins.net>
branch nick: misc-fixen
timestamp: Thu 2007-04-05 18:44:49 +1000
message:
  Document BzrDir.open_workingtree's new recommend_upgrade parameter.
modified:
  bzrlib/bzrdir.py               bzrdir.py-20060131065624-156dfea39c4387cb
=== modified file 'bzrlib/bzrdir.py'
--- a/bzrlib/bzrdir.py	2007-04-01 06:19:16 +0000
+++ b/bzrlib/bzrdir.py	2007-04-05 08:44:49 +0000
@@ -636,10 +636,14 @@
         """
         raise NotImplementedError(self.open_repository)
 
-    def open_workingtree(self, _unsupported=False):
+    def open_workingtree(self, _unsupported=False,
+            recommend_upgrade=True):
         """Open the workingtree object at this BzrDir if one is present.
-        
-        TODO: static convenience version of this?
+
+        :param recommend_upgrade: Optional keyword parameter, when True (the
+            default), emit through the ui module a recommendation that the user
+            upgrade the working tree when the workingtree being opened is old
+            (but still fully supported).
         """
         raise NotImplementedError(self.open_workingtree)