Rev 2829: Better explanation of deprecation in http://sourcefrog.net/bzr/trivial

[Martin Pool]

At http://sourcefrog.net/bzr/trivial

------------------------------------------------------------
revno: 2829
revision-id: mbp at sourcefrog.net-20070918042120-wg39u5k1itshbsks
parent: mbp at sourcefrog.net-20070918041604-olnnd90npihbyi2b
committer: Martin Pool <mbp at sourcefrog.net>
branch nick: trivial
timestamp: Tue 2007-09-18 14:21:20 +1000
message:
  Better explanation of deprecation
modified:
  bzrlib/tests/test_symbol_versioning.py test_symbol_versioning.py-20060105104851-51d7722c2018d42b
  doc/developers/HACKING.txt     HACKING-20050805200004-2a5dc975d870f78c
=== modified file 'bzrlib/tests/test_symbol_versioning.py'
--- a/bzrlib/tests/test_symbol_versioning.py	2007-09-18 04:16:04 +0000
+++ b/bzrlib/tests/test_symbol_versioning.py	2007-09-18 04:21:20 +0000
@@ -1,5 +1,6 @@
 # Copyright (C) 2006, 2007 Canonical Ltd
 #   Authors: Robert Collins <robert.collins at canonical.com>
+#   and others
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -63,6 +64,9 @@
         return 1
 
     def test_deprecated_static(self):
+        # XXX: The results are not quite right because the class name is not
+        # shown - however it is enough to give people a good indication of
+        # where the problem is.
         expected_warning = (
             "bzrlib.tests.test_symbol_versioning."
             "deprecated_static "

=== modified file 'doc/developers/HACKING.txt'
--- a/doc/developers/HACKING.txt	2007-09-17 03:47:46 +0000
+++ b/doc/developers/HACKING.txt	2007-09-18 04:21:20 +0000
@@ -628,8 +628,8 @@
 methods, functions, and other interfaces to indicate that they should no
 longer be used.
 
-To deprecate a static method this invocation is needed, in this particular
-order::
+To deprecate a static method you must call ``deprecated_function``
+(**not** method), after the staticmethod call::
 
     @staticmethod
     @deprecated_function(zero_ninetyone)