Rev 4672: Review feedback, add a docstring that we want to get rid of this eventually. in http://bazaar.launchpad.net/~jameinel/bzr/2.1.0b2-471193-st-and-chk-map

[John Arbash Meinel]

At http://bazaar.launchpad.net/~jameinel/bzr/2.1.0b2-471193-st-and-chk-map

------------------------------------------------------------
revno: 4672
revision-id: john at arbash-meinel.com-20091102173939-ygeujjd6rfp5kais
parent: john at arbash-meinel.com-20091102172752-avkrzlbiahwz6etd
committer: John Arbash Meinel <john at arbash-meinel.com>
branch nick: 2.1.0b2-471193-st-and-chk-map
timestamp: Mon 2009-11-02 11:39:39 -0600
message:
  Review feedback, add a docstring that we want to get rid of this eventually.
-------------- next part --------------
=== modified file 'bzrlib/static_tuple.py'
--- a/bzrlib/static_tuple.py	2009-11-02 17:15:20 +0000
+++ b/bzrlib/static_tuple.py	2009-11-02 17:39:39 +0000
@@ -31,6 +31,9 @@
 
     Cast it if necessary, but if the 'static_tuple' debug flag is set, raise an
     error instead.
+
+    As apis are improved, we will probably eventually stop calling this as it
+    adds overhead we shouldn't need.
     """
     if 'static_tuple' not in debug.debug_flags:
         return StaticTuple.from_sequence(obj)