~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/testing.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-24 06:59:15 UTC
  • mfrom: (5432.6.1 doc-applyDeprecated-602996)
  • Revision ID: pqm@pqm.ubuntu.com-20100924065915-djj64ixcdc33s6f4
(spiv) Mention applyDeprecated in the Testing Guide. (#602996) (John C
 Barstow)

Show diffs side-by-side

added added

removed removed

Lines of Context:
711
711
        _test_needs_features = [features.apport]
712
712
 
713
713
 
 
714
Testing deprecated code
 
715
-----------------------
 
716
 
 
717
When code is deprecated, it is still supported for some length of time,
 
718
usually until the next major version. The ``applyDeprecated`` helper
 
719
wraps calls to deprecated code to verify that it is correctly issuing the
 
720
deprecation warning, and also prevents the warnings from being printed
 
721
during test runs.
 
722
 
 
723
Typically patches that apply the ``@deprecated_function`` decorator should
 
724
update the accompanying tests to use the ``applyDeprecated`` wrapper.
 
725
 
 
726
``applyDeprecated`` is defined in ``bzrlib.tests.TestCase``. See the API
 
727
docs for more details.
 
728
 
 
729
 
714
730
Testing exceptions and errors
715
731
-----------------------------
716
732